# Garmo API: full documentation > Garmo API: AI photos and seven edits for fashion and product photos over REST. Base URL https://api.garmo.studio/v1. OpenAPI: https://garmo.studio/api/openapi.json. Agent skill: https://garmo.studio/api/skill/SKILL.md. Pricing: https://garmo.studio/api/pricing/. --- Source: https://garmo.studio/api/docs/ # Garmo API The Garmo API runs Garmo Studio from your own code. Generate makes new photos from one product photo and a prompt, on a model or without; seven edits change the photos you have: recolor a garment, change a pose, swap the model, ghost mannequin, change or remove the background, and upscale. Every request is an asynchronous job: the request returns in about two seconds, the images follow in 20 to 90 seconds. Base URL: https://api.garmo.studio/v1. Requests and answers are JSON; images can also be sent as multipart/form-data. The full machine-readable description is the OpenAPI 3.1 file. ## 1. Get a key Sign in to Garmo Studio and open Developers › API. Create a test key (gm_test_…) to build for free, or buy an API pack and create a live key (gm_live_…). A key is shown once; keep it on your server, never in a browser or an app. See Keys and authentication. Get an API key ## 2. Send your first edit This recolors the dress in a photo to terracotta. With a test key it costs nothing and the result is your own photo, so you can wire up the whole flow first. ``` curl https://api.garmo.studio/v1/edit/color \ -H "Authorization: Bearer $GARMO_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "image_url": "https://shop.example/products/dress-123.jpg", "color_hex": "#c8553d", "color_name": "terracotta", "garment": "dress" }' ``` ``` const r = await fetch("https://api.garmo.studio/v1/edit/color", { method: "POST", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}`, "Idempotency-Key": "order-123-color", "Content-Type": "application/json", }, body: JSON.stringify({"image_url": "https://shop.example/products/dress-123.jpg", "color_hex": "#c8553d", "color_name": "terracotta", "garment": "dress"}), }); const job = await r.json(); console.log(job.id, job.status); ``` ``` import os, requests r = requests.post( "https://api.garmo.studio/v1/edit/color", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}", "Idempotency-Key": "order-123-color"}, json={ "image_url": "https://shop.example/products/dress-123.jpg", "color_hex": "#c8553d", "color_name": "terracotta", "garment": "dress", }, ) job = r.json() print(job["id"], job["status"]) ``` ``` true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode(["image_url" => "https://shop.example/products/dress-123.jpg", "color_hex" => "#c8553d", "color_name" => "terracotta", "garment" => "dress"]), CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY"), "Idempotency-Key: order-123-color", "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/color") req = Net::HTTP::Post.new(uri) req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}" req["Idempotency-Key"] = "order-123-color" req["Content-Type"] = "application/json" req.body = res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` The answer is 202 Accepted with the job: ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "color", "status": "processing", "livemode": true, "outputs": [ { "id": "out_1", "status": "processing", "label": "dress · terracotta" } ], "credits_charged": 1, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": null } ``` ## 3. Get the result Either give a webhook_url in the request and receive the finished job (Webhooks), or poll the job every few seconds until status is no longer processing: ``` curl https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B \ -H "Authorization: Bearer $GARMO_API_KEY" ``` ``` const r = await fetch("https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B", { method: "GET", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}`, }, }); console.log(await r.json()); ``` ``` import os, requests r = requests.get( "https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}"}, ) job = r.json() print(r.json()) ``` ``` true, CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY")], ]); $job = json_decode(curl_exec($ch), true); print_r($job); ``` ``` require "net/http" require "json" uri = URI("https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B") req = Net::HTTP::Get.new(uri) req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}" res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) } job = JSON.parse(res.body) pp job ``` ``` package main import ( "fmt" "io" "net/http" "os" ) func main() { req, _ := http.NewRequest("GET", "https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("GARMO_API_KEY")) 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 { HttpRequest req = HttpRequest.newBuilder(URI.create("https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B")) .header("Authorization", "Bearer " + System.getenv("GARMO_API_KEY")) .GET() .build(); HttpResponse res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "color", "status": "completed", "livemode": true, "outputs": [ { "id": "out_1", "status": "succeeded", "label": "dress · terracotta", "url": "https://….r2.cloudflarestorage.com/renders/2026/11/8f3c…0.webp?X-Amz-Signature=…", "url_expires_at": "2026-11-20T14:00:00Z" } ], "credits_charged": 1, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": "2026-11-19T14:02:58Z" } ``` Each succeeded output has a signed url valid for about 24 hours; download the file or fetch the job again for a fresh link. Results also appear in your Garmo Studio library (live keys only). See Jobs and results. ## Credits Live jobs spend API credits from packs bought on the API page; Studio credits are not used. One credit is one image (a 4K upscale is two). The credits are taken when the job is created, and every image that fails or is canceled is refunded automatically: the job shows it in credits_refunded. Prices: API pricing. ## Sending images - image_url: a public https URL. Garmo downloads it (up to 12 MB, 8 seconds, 2 redirects). Private, local and cloud-metadata addresses are refused. - image_base64: the bytes, base64 or a data: URI. Good for small files. - upload_id: upload once with POST /uploads, then reuse the id in edits and generates while it is valid. - Multipart: a file field named image (or images[] for remove-background and upscale). JPEG, PNG and WebP, up to 12 MB and 40 megapixels. One request makes at most 12 images. ## Retries and idempotency Send an Idempotency-Key header (any string up to 80 characters, like your order or variant id) on edit requests. For 24 hours the same key with the same body returns the first job instead of making and charging a new one; the same key with a different body is refused with 409 idempotency_conflict. ## Limits Test keys: 5 create requests a minute, 2 images rendering at once. Live keys get higher limits with larger packs. Every answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; see Rate limits. --- Source: https://garmo.studio/api/docs/authentication/ # Keys and authentication Every request carries a key in the Authorization header: ``` curl https://api.garmo.studio/v1/account \ -H "Authorization: Bearer gm_live_…" ``` ## Live and test keys - Live keys (gm_live_…) make real images and spend API credits. They need an API pack on the account. - Test keys (gm_test_…) are free. Every endpoint works and validates parameters and images exactly like live, but nothing is sent to an image model: each output is your own input photo, ready in a few seconds. Use them in development and CI. Test jobs and the files sent with a test key are deleted after 24 hours. Jobs belong to the mode of the key that made them: a live key does not see test jobs and the other way round. Test jobs do not appear in the Studio library. ## Creating and revoking keys Keys are made on Developers › API in Garmo Studio, up to 10 live and 5 test keys per account. A key is shown once at creation; Garmo keeps only a hash of it. Revoke a key there the moment it may have leaked: requests with it then get 401 invalid_api_key. ## Keep keys on the server A key spends your credits. Call the API from your server, a serverless function or a workflow tool, never from a browser or a mobile app. The API sends no CORS headers for that reason. ## Authentication errors - 401 invalid_api_key: missing, unknown or revoked key. - 403 api_not_enabled: a live key on an account without an API pack. - 403 key_suspended or account_suspended: contact support@garmo.studio. --- Source: https://garmo.studio/api/docs/jobs/ # Jobs and results Every edit request creates a job. It starts as processing and ends as completed (at least one output succeeded), failed (none did) or canceled. Each image of the job is an output with its own status. ## The job object - Field | Description - id string | The job id, job_ plus 20 characters. - object string | Always "job". - tool string | The endpoint that made it: generate, remove-background, background, color, pose, model-swap, ghost-mannequin or upscale. - status string | "processing", then "completed" (at least one output succeeded), "failed" or "canceled". - livemode boolean | false for jobs made with a test key. - outputs array | One entry per image: id (out_1, out_2 …), status ("processing", "succeeded", "failed"), label, url and url_expires_at when succeeded, error {code, message} when failed. - credits_charged integer | Credits taken when the job was created (0 for a test key). - credits_refunded integer | Credits given back for outputs that failed or were canceled. - metadata object | Your metadata, or null. - created_at string | ISO 8601, UTC. - completed_at string | ISO 8601, UTC; null while processing. ### Output errors A failed output has error.code, and its credit is refunded: - content_refused | The model refused this image under its content rules. - generation_failed | The image could not be made. - timeout | The image took too long and was stopped. - canceled | The job was canceled before this image was made. ## Get a job GET/jobs/{id} Returns the job. Poll every 3 to 5 seconds while it is processing; status reads have their own, higher rate limit. Output links are signed and valid about 24 hours; each call returns a current one. ``` curl https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B \ -H "Authorization: Bearer $GARMO_API_KEY" ``` ``` const r = await fetch("https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B", { method: "GET", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}`, }, }); console.log(await r.json()); ``` ``` import os, requests r = requests.get( "https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}"}, ) job = r.json() print(r.json()) ``` ``` true, CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY")], ]); $job = json_decode(curl_exec($ch), true); print_r($job); ``` ``` require "net/http" require "json" uri = URI("https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B") req = Net::HTTP::Get.new(uri) req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}" res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) } job = JSON.parse(res.body) pp job ``` ``` package main import ( "fmt" "io" "net/http" "os" ) func main() { req, _ := http.NewRequest("GET", "https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("GARMO_API_KEY")) 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 { HttpRequest req = HttpRequest.newBuilder(URI.create("https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B")) .header("Authorization", "Bearer " + System.getenv("GARMO_API_KEY")) .GET() .build(); HttpResponse res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` ## List jobs GET/jobs Jobs of this account made with keys of the same mode (live or test), newest first. - Parameter | Description - limit integer | Between 1 and 100. Default 20. - starting_after string | A job id: list the jobs after it. - status string | processing, completed, failed or canceled. ``` curl https://api.garmo.studio/v1/jobs?limit=20&status=completed \ -H "Authorization: Bearer $GARMO_API_KEY" ``` ``` const r = await fetch("https://api.garmo.studio/v1/jobs?limit=20&status=completed", { method: "GET", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}`, }, }); console.log(await r.json()); ``` ``` import os, requests r = requests.get( "https://api.garmo.studio/v1/jobs?limit=20&status=completed", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}"}, ) job = r.json() print(r.json()) ``` ``` true, CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY")], ]); $job = json_decode(curl_exec($ch), true); print_r($job); ``` ``` require "net/http" require "json" uri = URI("https://api.garmo.studio/v1/jobs?limit=20&status=completed") req = Net::HTTP::Get.new(uri) req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}" res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) } job = JSON.parse(res.body) pp job ``` ``` package main import ( "fmt" "io" "net/http" "os" ) func main() { req, _ := http.NewRequest("GET", "https://api.garmo.studio/v1/jobs?limit=20&status=completed", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("GARMO_API_KEY")) 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 { HttpRequest req = HttpRequest.newBuilder(URI.create("https://api.garmo.studio/v1/jobs?limit=20&status=completed")) .header("Authorization", "Bearer " + System.getenv("GARMO_API_KEY")) .GET() .build(); HttpResponse res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` ``` { "object": "list", "data": [ "…jobs…" ], "has_more": true } ``` ## Cancel a job POST/jobs/{id}/cancel Stops the outputs still rendering and refunds their credits; outputs already finished are kept. A finished job is returned unchanged. ``` curl -X POST https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B/cancel \ -H "Authorization: Bearer $GARMO_API_KEY" ``` ``` const r = await fetch("https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B/cancel", { method: "POST", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}`, }, }); console.log(await r.json()); ``` ``` import os, requests r = requests.post( "https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B/cancel", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}"}, ) job = r.json() print(r.json()) ``` ``` true, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY")], ]); $job = json_decode(curl_exec($ch), true); print_r($job); ``` ``` require "net/http" require "json" uri = URI("https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B/cancel") req = Net::HTTP::Post.new(uri) req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}" res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) } job = JSON.parse(res.body) pp job ``` ``` package main import ( "fmt" "io" "net/http" "os" ) func main() { req, _ := http.NewRequest("POST", "https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B/cancel", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("GARMO_API_KEY")) 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 { HttpRequest req = HttpRequest.newBuilder(URI.create("https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B/cancel")) .header("Authorization", "Bearer " + System.getenv("GARMO_API_KEY")) .POST(HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` --- Source: https://garmo.studio/api/docs/webhooks/ # Webhooks Add webhook_url (https, a public address) to an edit request and Garmo POSTs the job there when it ends, so you never have to poll. ## The event type is job.completed, job.failed or job.canceled; data is the job exactly as GET /jobs/{id} returns it, including your metadata. ``` { "id": "evt_1842a7c9e3ea2b51", "type": "job.completed", "created_at": "2026-11-19T14:02:59Z", "data": { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "color", "status": "completed", "livemode": true, "outputs": [ { "id": "out_1", "status": "succeeded", "label": "dress · terracotta", "url": "https://….r2.cloudflarestorage.com/renders/2026/11/8f3c…0.webp?X-Amz-Signature=…", "url_expires_at": "2026-11-20T14:00:00Z" } ], "credits_charged": 1, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": "2026-11-19T14:02:58Z" } } ``` ## Verify the signature Webhooks are signed the Standard Webhooks way with the webhook secret of the key that made the job (whsec_…, shown on the API page, one per key). Three headers come with each request: - webhook-id: the same on every retry of one delivery; use it to drop repeats. - webhook-timestamp: Unix seconds. Refuse anything older than five minutes. - webhook-signature: v1, plus the base64 HMAC-SHA256 of id.timestamp.body, keyed with the base64-decoded part of the secret after whsec_. Verify against the raw body, before parsing JSON. The official Standard Webhooks libraries work as they are. ``` import base64, hashlib, hmac, time def verify(secret: str, headers, body: bytes) -> bool: msg_id = headers["webhook-id"] ts = headers["webhook-timestamp"] if abs(time.time() - int(ts)) > 300: return False key = base64.b64decode(secret.removeprefix("whsec_")) signed = f"{msg_id}.{ts}.".encode() + body expected = base64.b64encode(hmac.new(key, signed, hashlib.sha256).digest()).decode() return any(hmac.compare_digest(expected, s.split(",", 1)[1]) for s in headers["webhook-signature"].split() if "," in s) ``` ``` import crypto from "node:crypto"; export function verify(secret, headers, body /* raw string */) { const id = headers["webhook-id"], ts = headers["webhook-timestamp"]; if (Math.abs(Date.now() / 1000 - Number(ts)) > 300) return false; const key = Buffer.from(secret.replace(/^whsec_/, ""), "base64"); const expected = crypto.createHmac("sha256", key).update(`${id}.${ts}.${body}`).digest("base64"); return headers["webhook-signature"].split(" ").some(s => { const sig = s.split(",")[1] || ""; return sig.length === expected.length && crypto.timingSafeEqual(Buffer.from(sig), Buffer.from(expected)); }); } ``` ``` 300) return false; $key = base64_decode(preg_replace('/^whsec_/', '', $secret)); $expected = base64_encode(hash_hmac('sha256', "$id.$ts.$body", $key, true)); foreach (explode(' ', $_SERVER['HTTP_WEBHOOK_SIGNATURE'] ?? '') as $part) { if (hash_equals($expected, explode(',', $part, 2)[1] ?? '')) return true; } return false; } ``` ## Answers and retries Answer with any 2xx within 3 seconds; do the work after answering. Anything else, a timeout or a redirect counts as failed and the delivery is retried after 1 minute, 5 minutes, 30 minutes, 2 hours and 12 hours. After that it stops; the job is always available with GET /jobs/{id}. The webhook address is checked on every try: it must be https and resolve to a public address. Redirects are not followed. --- Source: https://garmo.studio/api/docs/agents/ # AI coding agents A coding agent such as Claude Code, Codex or Cursor can call the Garmo API for you: it finds your product photos, sends them, waits for the job and saves the finished images in a folder. You describe what you want; you do not write the code. ## 1. Give the agent a key Put an API key in the environment the agent runs in, never in a prompt or a file you commit. Start with a free test key: it runs everything and returns your own photo as the result. ``` export GARMO_API_KEY=gm_test_… ``` ## 2. Point it at the docs Every docs page is also plain Markdown, at the same address with .md (for example /api/docs/generate.md), and the whole documentation is one file at /api/docs/llms-full.txt. A prompt to start from: ``` Read https://garmo.studio/api/docs/generate.md, then make two on-model photos of ./dress.jpg and save them in ./photos ``` ## 3. Or install the Garmo skill The skill is one SKILL.md file that teaches an agent the whole workflow: upload, create, wait, download. Claude Code reads skills from ~/.claude/skills/, Codex from ~/.codex/skills/, and Cursor reads both. This puts it in the two folders: ``` for d in ~/.claude/skills ~/.codex/skills; do mkdir -p "$d/garmo" && curl -fsSL https://garmo.studio/api/skill/SKILL.md -o "$d/garmo/SKILL.md" done ``` Then ask in plain words, in any language: "make two on-model photos of every photo in ./new-arrivals". The agent uses the skill when the task matches it. The file: /api/skill/SKILL.md. ## Other agents Gemini CLI, GitHub Copilot and any agent that can make HTTP requests can use the Markdown docs, the OpenAPI 3.1 file or the skill the same way. An agent spends credits like any other client. Build with a test key, then switch to a live key; a live key's limits and balance are on GET /account. --- Source: https://garmo.studio/api/docs/generate/ # Generate photos POST/generate Makes new photos from one product photo. Without a model: product photos in the setting your prompt describes. With a model: the product worn by a Garmo model (or your own), in planned poses, in a catalog scene or one Garmo picks. Cost: 1 credit per image. Images: Send exactly one photo: image_url, image_base64 or upload_id (or a multipart file named image). It makes count images (1 to 4). Category, scene and gender are only accepted together with model. Overview and examples: Photoshoot API. ## Parameters - Parameter | Description - prompt string | What you want, in your own words and any language (up to 500 characters): setting, light, props, mood. Without a model it decides everything, including whether hands or a person appear; with a model it is the art direction. Leave it out and Garmo plans the set. - count integer | How many images, 1 to 4. Each is a different angle or pose. Default 1 . - model string | Put the product on a model: an id from GET /catalog/models (a Garmo model or custom_ for your own), or "auto" to let Garmo pick one. Leave it out for product photos without a model. - category string | With a model: what the product is, so the poses fit. Default "clothing" . One of: clothing , shoes , jewelry - scene string | With a model: the place. auto plans a setting that suits the product. Default "auto" . One of: auto , studio , street , editorial - gender string | With model "auto": who wears it. Default "female" . One of: female , male - aspect_ratio string | Shape of the images. Default "3:4" . One of: 3:4 , 2:3 , 1:1 , 4:5 , 9:16 - image_url string | Public https URL of the photo to edit. JPEG, PNG or WebP, up to 12 MB. Private and local addresses are refused. - image_base64 string | The photo itself, base64-encoded (a data: URI is fine). For large files use upload_id instead. - upload_id string | An id from POST /uploads. - webhook_url string | https address Garmo POSTs the finished job to (signed, see Webhooks). - metadata object | Your own JSON object (up to 1,000 characters), returned with the job and in the webhook. Header Idempotency-Key (optional): see Retries and idempotency. ## Example ``` curl https://api.garmo.studio/v1/generate \ -H "Authorization: Bearer $GARMO_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "image_url": "https://shop.example/products/sundress-41.jpg", "model": "auto", "prompt": "a sunlit stone colonnade, warm late-afternoon light", "count": 2 }' ``` ``` const r = await fetch("https://api.garmo.studio/v1/generate", { method: "POST", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}`, "Idempotency-Key": "order-123-generate", "Content-Type": "application/json", }, body: JSON.stringify({"image_url": "https://shop.example/products/sundress-41.jpg", "model": "auto", "prompt": "a sunlit stone colonnade, warm late-afternoon light", "count": 2}), }); const job = await r.json(); console.log(job.id, job.status); ``` ``` import os, requests r = requests.post( "https://api.garmo.studio/v1/generate", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}", "Idempotency-Key": "order-123-generate"}, json={ "image_url": "https://shop.example/products/sundress-41.jpg", "model": "auto", "prompt": "a sunlit stone colonnade, warm late-afternoon light", "count": 2, }, ) job = r.json() print(job["id"], job["status"]) ``` ``` true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode(["image_url" => "https://shop.example/products/sundress-41.jpg", "model" => "auto", "prompt" => "a sunlit stone colonnade, warm late-afternoon light", "count" => 2]), CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY"), "Idempotency-Key: order-123-generate", "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/generate") req = Net::HTTP::Post.new(uri) req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}" req["Idempotency-Key"] = "order-123-generate" req["Content-Type"] = "application/json" req.body = res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` ### Response: 202 Accepted ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "generate", "status": "processing", "livemode": true, "outputs": [ { "id": "out_1", "status": "processing", "label": "Front" }, { "id": "out_2", "status": "processing", "label": "Walking" } ], "credits_charged": 2, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": null } ``` ### The finished job ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "generate", "status": "completed", "livemode": true, "outputs": [ { "id": "out_1", "status": "succeeded", "label": "Front", "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": "Walking", "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" } ``` ## Errors 400 invalid_request names the parameter that is missing or wrong. Image problems are invalid_image, image_too_large or image_unreachable. 402 insufficient_credits says how many credits the request needs. All codes: Errors. --- Source: https://garmo.studio/api/docs/remove-background/ # Remove background POST/edit/remove-background Cuts the product or model out of the photo, onto transparency, white or a color of your choice. Cost: 1 credit per photo. Images: Send one photo the same way, or up to 10 in images[] (or multipart files named images[]). It makes one image per photo, at most 12 per request. Overview and examples: Background remover API. ## Parameters - Parameter | Description - background string | What the cut-out sits on. Default "transparent" . One of: transparent , white , color - color_hex string | The color when background is "color", like "#efe8dc". - shadow boolean | Adds a soft contact shadow under the subject (white and color backgrounds). Default false . - image_url string | Public https URL of the photo to edit. JPEG, PNG or WebP, up to 12 MB. Private and local addresses are refused. - image_base64 string | The photo itself, base64-encoded (a data: URI is fine). For large files use upload_id instead. - upload_id string | An id from POST /uploads. - images array | Several photos at once (up to 10); each item is a URL string or an object with image_url, image_base64 or upload_id. Each photo is edited on its own. - webhook_url string | https address Garmo POSTs the finished job to (signed, see Webhooks). - metadata object | Your own JSON object (up to 1,000 characters), returned with the job and in the webhook. Header Idempotency-Key (optional): see Retries and idempotency. ## Example ``` curl https://api.garmo.studio/v1/edit/remove-background \ -H "Authorization: Bearer $GARMO_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "image_url": "https://shop.example/products/bag-77.jpg", "background": "white", "shadow": true }' ``` ``` const r = await fetch("https://api.garmo.studio/v1/edit/remove-background", { method: "POST", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}`, "Idempotency-Key": "order-123-remove-background", "Content-Type": "application/json", }, body: JSON.stringify({"image_url": "https://shop.example/products/bag-77.jpg", "background": "white", "shadow": true}), }); const job = await r.json(); console.log(job.id, job.status); ``` ``` import os, requests r = requests.post( "https://api.garmo.studio/v1/edit/remove-background", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}", "Idempotency-Key": "order-123-remove-background"}, json={ "image_url": "https://shop.example/products/bag-77.jpg", "background": "white", "shadow": True, }, ) job = r.json() print(job["id"], job["status"]) ``` ``` true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode(["image_url" => "https://shop.example/products/bag-77.jpg", "background" => "white", "shadow" => true]), CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY"), "Idempotency-Key: order-123-remove-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/remove-background") req = Net::HTTP::Post.new(uri) req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}" req["Idempotency-Key"] = "order-123-remove-background" req["Content-Type"] = "application/json" req.body = res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` ### Response: 202 Accepted ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "remove-background", "status": "processing", "livemode": true, "outputs": [ { "id": "out_1", "status": "processing", "label": "White · shadow" } ], "credits_charged": 1, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": null } ``` ### The finished job ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "remove-background", "status": "completed", "livemode": true, "outputs": [ { "id": "out_1", "status": "succeeded", "label": "White · shadow", "url": "https://….r2.cloudflarestorage.com/renders/2026/11/8f3c…0.webp?X-Amz-Signature=…", "url_expires_at": "2026-11-20T14:00:00Z" } ], "credits_charged": 1, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": "2026-11-19T14:02:58Z" } ``` ## Errors 400 invalid_request names the parameter that is missing or wrong. Image problems are invalid_image, image_too_large or image_unreachable. 402 insufficient_credits says how many credits the request needs. All codes: Errors. --- Source: https://garmo.studio/api/docs/background/ # Change background POST/edit/background Keeps the subject exactly and puts it in a new place: a studio color, an interior, a street or a surface, with the light matched. Cost: 1 credit per scene. Images: Send exactly one photo: image_url, image_base64 or upload_id (or a multipart file named image). It makes one image per scene (plus one for a description or scene photo), at most 12 per request. Give at least one of scenes, description or scene_image_url. Overview and examples: Background changer API. ## Parameters - Parameter | Description - scenes array | Scene ids from GET /catalog/scenes. One of: white , beige , grey , sage , lobby , cafe , gallery , living , paris , terrace , coast , desert , lake , marble , linen , wood , stone - description string | Your own scene in words (up to 300 characters). - scene_image_url string | A photo of the place to use as the new background (or scene_image_base64, scene_image_upload_id). - format string | Shape of the result; the scene is extended so nothing of the subject is cut off. Default "same" . One of: same , square , portrait , story - image_url string | Public https URL of the photo to edit. JPEG, PNG or WebP, up to 12 MB. Private and local addresses are refused. - image_base64 string | The photo itself, base64-encoded (a data: URI is fine). For large files use upload_id instead. - upload_id string | An id from POST /uploads. - webhook_url string | https address Garmo POSTs the finished job to (signed, see Webhooks). - metadata object | Your own JSON object (up to 1,000 characters), returned with the job and in the webhook. Header Idempotency-Key (optional): see Retries and idempotency. ## Example ``` 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"]) ``` ``` 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 = res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` ### Response: 202 Accepted ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "background", "status": "processing", "livemode": true, "outputs": [ { "id": "out_1", "status": "processing", "label": "Your scene" }, { "id": "out_2", "status": "processing", "label": "Coast at sunset" } ], "credits_charged": 2, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": null } ``` ### The finished job ``` { "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" } ``` ## Errors 400 invalid_request names the parameter that is missing or wrong. Image problems are invalid_image, image_too_large or image_unreachable. 402 insufficient_credits says how many credits the request needs. All codes: Errors. --- Source: https://garmo.studio/api/docs/color/ # Change clothing color POST/edit/color Recolors one garment to an exact hex color and keeps its fabric, folds, print and everything else in the photo. Cost: 1 credit. Images: Send exactly one photo: image_url, image_base64 or upload_id (or a multipart file named image). It makes one image, at most 12 per request. Overview and examples: Clothes color changer API. ## Parameters - Parameter | Description - color_hex required string | The new color, like "#c8553d". - color_name string | A name for the color (up to 40 characters); helps with shades a hex alone leaves open. - garment string | Which garment to recolor when there are several, like "dress" or "jacket". - image_url string | Public https URL of the photo to edit. JPEG, PNG or WebP, up to 12 MB. Private and local addresses are refused. - image_base64 string | The photo itself, base64-encoded (a data: URI is fine). For large files use upload_id instead. - upload_id string | An id from POST /uploads. - webhook_url string | https address Garmo POSTs the finished job to (signed, see Webhooks). - metadata object | Your own JSON object (up to 1,000 characters), returned with the job and in the webhook. Header Idempotency-Key (optional): see Retries and idempotency. ## Example ``` curl https://api.garmo.studio/v1/edit/color \ -H "Authorization: Bearer $GARMO_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "image_url": "https://shop.example/products/dress-123.jpg", "color_hex": "#c8553d", "color_name": "terracotta", "garment": "dress" }' ``` ``` const r = await fetch("https://api.garmo.studio/v1/edit/color", { method: "POST", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}`, "Idempotency-Key": "order-123-color", "Content-Type": "application/json", }, body: JSON.stringify({"image_url": "https://shop.example/products/dress-123.jpg", "color_hex": "#c8553d", "color_name": "terracotta", "garment": "dress"}), }); const job = await r.json(); console.log(job.id, job.status); ``` ``` import os, requests r = requests.post( "https://api.garmo.studio/v1/edit/color", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}", "Idempotency-Key": "order-123-color"}, json={ "image_url": "https://shop.example/products/dress-123.jpg", "color_hex": "#c8553d", "color_name": "terracotta", "garment": "dress", }, ) job = r.json() print(job["id"], job["status"]) ``` ``` true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode(["image_url" => "https://shop.example/products/dress-123.jpg", "color_hex" => "#c8553d", "color_name" => "terracotta", "garment" => "dress"]), CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY"), "Idempotency-Key: order-123-color", "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/color") req = Net::HTTP::Post.new(uri) req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}" req["Idempotency-Key"] = "order-123-color" req["Content-Type"] = "application/json" req.body = res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` ### Response: 202 Accepted ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "color", "status": "processing", "livemode": true, "outputs": [ { "id": "out_1", "status": "processing", "label": "dress · terracotta" } ], "credits_charged": 1, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": null } ``` ### The finished job ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "color", "status": "completed", "livemode": true, "outputs": [ { "id": "out_1", "status": "succeeded", "label": "dress · terracotta", "url": "https://….r2.cloudflarestorage.com/renders/2026/11/8f3c…0.webp?X-Amz-Signature=…", "url_expires_at": "2026-11-20T14:00:00Z" } ], "credits_charged": 1, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": "2026-11-19T14:02:58Z" } ``` ## Errors 400 invalid_request names the parameter that is missing or wrong. Image problems are invalid_image, image_too_large or image_unreachable. 402 insufficient_credits says how many credits the request needs. All codes: Errors. --- Source: https://garmo.studio/api/docs/pose/ # Change pose POST/edit/pose Makes new photos of the same model in the same outfit and place, in other poses: back view, side, walking, seated and more. Cost: 1 credit per pose. Images: Send exactly one photo: image_url, image_base64 or upload_id (or a multipart file named image). It makes one image per pose (plus one for a description or pose photo), at most 12 per request. Give at least one of poses, description or pose_image_url. Overview and examples: Pose changer API. ## Parameters - Parameter | Description - poses array | Pose ids from GET /catalog/poses. One of: standing , three , side , back , walking , seated , pockets , leaning - framing string | How much of the model is in frame. Default "full" . One of: full , knee , waist - description string | A pose of your own in words (up to 200 characters). - pose_image_url string | A photo of someone in the pose you want; only the pose is copied (or pose_image_base64, pose_image_upload_id). - back_image_urls array | Up to 2 photos of the real back of the garment, so a back view is true to it. - image_url string | Public https URL of the photo to edit. JPEG, PNG or WebP, up to 12 MB. Private and local addresses are refused. - image_base64 string | The photo itself, base64-encoded (a data: URI is fine). For large files use upload_id instead. - upload_id string | An id from POST /uploads. - webhook_url string | https address Garmo POSTs the finished job to (signed, see Webhooks). - metadata object | Your own JSON object (up to 1,000 characters), returned with the job and in the webhook. Header Idempotency-Key (optional): see Retries and idempotency. ## Example ``` curl https://api.garmo.studio/v1/edit/pose \ -H "Authorization: Bearer $GARMO_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "image_url": "https://shop.example/products/jacket-7-on-model.jpg", "poses": [ "walking", "side" ], "framing": "full" }' ``` ``` const r = await fetch("https://api.garmo.studio/v1/edit/pose", { method: "POST", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}`, "Idempotency-Key": "order-123-pose", "Content-Type": "application/json", }, body: JSON.stringify({"image_url": "https://shop.example/products/jacket-7-on-model.jpg", "poses": ["walking", "side"], "framing": "full"}), }); const job = await r.json(); console.log(job.id, job.status); ``` ``` import os, requests r = requests.post( "https://api.garmo.studio/v1/edit/pose", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}", "Idempotency-Key": "order-123-pose"}, json={ "image_url": "https://shop.example/products/jacket-7-on-model.jpg", "poses": ["walking", "side"], "framing": "full", }, ) job = r.json() print(job["id"], job["status"]) ``` ``` true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode(["image_url" => "https://shop.example/products/jacket-7-on-model.jpg", "poses" => ["walking", "side"], "framing" => "full"]), CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY"), "Idempotency-Key: order-123-pose", "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/pose") req = Net::HTTP::Post.new(uri) req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}" req["Idempotency-Key"] = "order-123-pose" req["Content-Type"] = "application/json" req.body = res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` ### Response: 202 Accepted ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "pose", "status": "processing", "livemode": true, "outputs": [ { "id": "out_1", "status": "processing", "label": "Walking" }, { "id": "out_2", "status": "processing", "label": "Side" } ], "credits_charged": 2, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": null } ``` ### The finished job ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "pose", "status": "completed", "livemode": true, "outputs": [ { "id": "out_1", "status": "succeeded", "label": "Walking", "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": "Side", "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" } ``` ## Errors 400 invalid_request names the parameter that is missing or wrong. Image problems are invalid_image, image_too_large or image_unreachable. 402 insufficient_credits says how many credits the request needs. All codes: Errors. --- Source: https://garmo.studio/api/docs/model-swap/ # Swap the model POST/edit/model-swap Replaces the person in an on-model photo with another model, keeping the outfit, pose, framing and light. Cost: 1 credit per model. Images: Send exactly one photo: image_url, image_base64 or upload_id (or a multipart file named image). It makes one image per model, at most 12 per request. Overview and examples: Model swap API. ## Parameters - Parameter | Description - models required array | Model ids from GET /catalog/models: Garmo models by name ("klara") or your own models in Garmo Studio ("custom_"). - image_url string | Public https URL of the photo to edit. JPEG, PNG or WebP, up to 12 MB. Private and local addresses are refused. - image_base64 string | The photo itself, base64-encoded (a data: URI is fine). For large files use upload_id instead. - upload_id string | An id from POST /uploads. - webhook_url string | https address Garmo POSTs the finished job to (signed, see Webhooks). - metadata object | Your own JSON object (up to 1,000 characters), returned with the job and in the webhook. Header Idempotency-Key (optional): see Retries and idempotency. ## Example ``` curl https://api.garmo.studio/v1/edit/model-swap \ -H "Authorization: Bearer $GARMO_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "image_url": "https://shop.example/products/blazer-dress-9.jpg", "models": [ "amara", "emma" ] }' ``` ``` const r = await fetch("https://api.garmo.studio/v1/edit/model-swap", { method: "POST", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}`, "Idempotency-Key": "order-123-model-swap", "Content-Type": "application/json", }, body: JSON.stringify({"image_url": "https://shop.example/products/blazer-dress-9.jpg", "models": ["amara", "emma"]}), }); const job = await r.json(); console.log(job.id, job.status); ``` ``` import os, requests r = requests.post( "https://api.garmo.studio/v1/edit/model-swap", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}", "Idempotency-Key": "order-123-model-swap"}, json={ "image_url": "https://shop.example/products/blazer-dress-9.jpg", "models": ["amara", "emma"], }, ) job = r.json() print(job["id"], job["status"]) ``` ``` true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode(["image_url" => "https://shop.example/products/blazer-dress-9.jpg", "models" => ["amara", "emma"]]), CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY"), "Idempotency-Key: order-123-model-swap", "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/model-swap") req = Net::HTTP::Post.new(uri) req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}" req["Idempotency-Key"] = "order-123-model-swap" req["Content-Type"] = "application/json" req.body = res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` ### Response: 202 Accepted ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "model-swap", "status": "processing", "livemode": true, "outputs": [ { "id": "out_1", "status": "processing", "label": "Amara" }, { "id": "out_2", "status": "processing", "label": "Emma" } ], "credits_charged": 2, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": null } ``` ### The finished job ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "model-swap", "status": "completed", "livemode": true, "outputs": [ { "id": "out_1", "status": "succeeded", "label": "Amara", "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": "Emma", "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" } ``` ## Errors 400 invalid_request names the parameter that is missing or wrong. Image problems are invalid_image, image_too_large or image_unreachable. 402 insufficient_credits says how many credits the request needs. All codes: Errors. --- Source: https://garmo.studio/api/docs/ghost-mannequin/ # Ghost mannequin POST/edit/ghost-mannequin Turns a garment photo (on a model, mannequin or hanger) into an invisible-mannequin product shot with its worn 3D shape. Cost: 1 credit. Images: Send exactly one photo: image_url, image_base64 or upload_id (or a multipart file named image). It makes one image, at most 12 per request. Overview and examples: Ghost mannequin API. ## Parameters - Parameter | Description - background string | The background in a few words (up to 200 characters); a clean light studio background when empty. - image_url string | Public https URL of the photo to edit. JPEG, PNG or WebP, up to 12 MB. Private and local addresses are refused. - image_base64 string | The photo itself, base64-encoded (a data: URI is fine). For large files use upload_id instead. - upload_id string | An id from POST /uploads. - webhook_url string | https address Garmo POSTs the finished job to (signed, see Webhooks). - metadata object | Your own JSON object (up to 1,000 characters), returned with the job and in the webhook. Header Idempotency-Key (optional): see Retries and idempotency. ## Example ``` curl https://api.garmo.studio/v1/edit/ghost-mannequin \ -H "Authorization: Bearer $GARMO_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "image_url": "https://shop.example/products/oxford-shirt-4.jpg", "background": "light grey studio" }' ``` ``` const r = await fetch("https://api.garmo.studio/v1/edit/ghost-mannequin", { method: "POST", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}`, "Idempotency-Key": "order-123-ghost-mannequin", "Content-Type": "application/json", }, body: JSON.stringify({"image_url": "https://shop.example/products/oxford-shirt-4.jpg", "background": "light grey studio"}), }); const job = await r.json(); console.log(job.id, job.status); ``` ``` import os, requests r = requests.post( "https://api.garmo.studio/v1/edit/ghost-mannequin", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}", "Idempotency-Key": "order-123-ghost-mannequin"}, json={ "image_url": "https://shop.example/products/oxford-shirt-4.jpg", "background": "light grey studio", }, ) job = r.json() print(job["id"], job["status"]) ``` ``` true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode(["image_url" => "https://shop.example/products/oxford-shirt-4.jpg", "background" => "light grey studio"]), CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY"), "Idempotency-Key: order-123-ghost-mannequin", "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/ghost-mannequin") req = Net::HTTP::Post.new(uri) req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}" req["Idempotency-Key"] = "order-123-ghost-mannequin" req["Content-Type"] = "application/json" req.body = res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` ### Response: 202 Accepted ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "ghost-mannequin", "status": "processing", "livemode": true, "outputs": [ { "id": "out_1", "status": "processing", "label": "light grey studio" } ], "credits_charged": 1, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": null } ``` ### The finished job ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "ghost-mannequin", "status": "completed", "livemode": true, "outputs": [ { "id": "out_1", "status": "succeeded", "label": "light grey studio", "url": "https://….r2.cloudflarestorage.com/renders/2026/11/8f3c…0.webp?X-Amz-Signature=…", "url_expires_at": "2026-11-20T14:00:00Z" } ], "credits_charged": 1, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": "2026-11-19T14:02:58Z" } ``` ## Errors 400 invalid_request names the parameter that is missing or wrong. Image problems are invalid_image, image_too_large or image_unreachable. 402 insufficient_credits says how many credits the request needs. All codes: Errors. --- Source: https://garmo.studio/api/docs/upscale/ # Upscale POST/edit/upscale Makes a product photo sharp at 2048 or 4096 px on the long side, restoring fabric and material detail without changing the photo. Cost: 1 credit per photo at 2k, 2 at 4k. Images: Send one photo the same way, or up to 10 in images[] (or multipart files named images[]). It makes one image per photo, at most 12 per request. Overview and examples: Image upscaler API. ## Parameters - Parameter | Description - resolution string | Long side of the result: 2k = 2048 px, 4k = 4096 px. Default "2k" . One of: 2k , 4k - detail string | "enhanced" restores fine material detail; "natural" only sharpens what is there. Default "enhanced" . One of: enhanced , natural - image_url string | Public https URL of the photo to edit. JPEG, PNG or WebP, up to 12 MB. Private and local addresses are refused. - image_base64 string | The photo itself, base64-encoded (a data: URI is fine). For large files use upload_id instead. - upload_id string | An id from POST /uploads. - images array | Several photos at once (up to 10); each item is a URL string or an object with image_url, image_base64 or upload_id. Each photo is edited on its own. - webhook_url string | https address Garmo POSTs the finished job to (signed, see Webhooks). - metadata object | Your own JSON object (up to 1,000 characters), returned with the job and in the webhook. Header Idempotency-Key (optional): see Retries and idempotency. ## Example ``` curl https://api.garmo.studio/v1/edit/upscale \ -H "Authorization: Bearer $GARMO_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "images": [ "https://shop.example/p/ring-1.jpg", "https://shop.example/p/ring-2.jpg" ], "resolution": "4k" }' ``` ``` const r = await fetch("https://api.garmo.studio/v1/edit/upscale", { method: "POST", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}`, "Idempotency-Key": "order-123-upscale", "Content-Type": "application/json", }, body: JSON.stringify({"images": ["https://shop.example/p/ring-1.jpg", "https://shop.example/p/ring-2.jpg"], "resolution": "4k"}), }); const job = await r.json(); console.log(job.id, job.status); ``` ``` import os, requests r = requests.post( "https://api.garmo.studio/v1/edit/upscale", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}", "Idempotency-Key": "order-123-upscale"}, json={ "images": ["https://shop.example/p/ring-1.jpg", "https://shop.example/p/ring-2.jpg"], "resolution": "4k", }, ) job = r.json() print(job["id"], job["status"]) ``` ``` true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode(["images" => ["https://shop.example/p/ring-1.jpg", "https://shop.example/p/ring-2.jpg"], "resolution" => "4k"]), CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY"), "Idempotency-Key: order-123-upscale", "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/upscale") req = Net::HTTP::Post.new(uri) req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}" req["Idempotency-Key"] = "order-123-upscale" req["Content-Type"] = "application/json" req.body = res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` ### Response: 202 Accepted ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "upscale", "status": "processing", "livemode": true, "outputs": [ { "id": "out_1", "status": "processing", "label": "4K" }, { "id": "out_2", "status": "processing", "label": "4K" } ], "credits_charged": 4, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": null } ``` ### The finished job ``` { "id": "job_8Kq2xV7mPz4LtR9wNc3B", "object": "job", "tool": "upscale", "status": "completed", "livemode": true, "outputs": [ { "id": "out_1", "status": "succeeded", "label": "4K", "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": "4K", "url": "https://….r2.cloudflarestorage.com/renders/2026/11/8f3c…1.webp?X-Amz-Signature=…", "url_expires_at": "2026-11-20T14:00:00Z" } ], "credits_charged": 4, "credits_refunded": 0, "metadata": { "sku": "DR-123" }, "created_at": "2026-11-19T14:02:11Z", "completed_at": "2026-11-19T14:02:58Z" } ``` ## Errors 400 invalid_request names the parameter that is missing or wrong. Image problems are invalid_image, image_too_large or image_unreachable. 402 insufficient_credits says how many credits the request needs. All codes: Errors. --- Source: https://garmo.studio/api/docs/uploads/ # Uploads POST/uploads Sends a photo once and returns an upload_id to use in any edit as "upload_id": "upl_…" or inside images[]. Useful when the same photo goes to several edits, or when it is too large for base64. - Parameter | Description - file required file | Multipart field: a JPEG, PNG or WebP image up to 12 MB. ``` curl https://api.garmo.studio/v1/uploads \ -H "Authorization: Bearer $GARMO_API_KEY" \ -F "file=@dress-123.jpg" ``` ``` import os, requests r = requests.post( "https://api.garmo.studio/v1/uploads", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}"}, files={"file": open("dress-123.jpg", "rb")}, ) upload_id = r.json()["id"] ``` ``` import { openAsBlob } from "node:fs"; const form = new FormData(); form.append("file", await openAsBlob("dress-123.jpg"), "dress-123.jpg"); const r = await fetch("https://api.garmo.studio/v1/uploads", { method: "POST", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}` }, body: form, }); const { id } = await r.json(); ``` ``` { "id": "upl_4821_9f2c1e0a7b3d5e6f", "object": "upload", "size": 845211 } ``` An upload belongs to your account and can only be used with your keys of the same mode. Uploads count as create requests for rate limits. An account can send up to 2,000 files a day with live keys and 50 with test keys (UTC days), counting uploads and images sent in requests. Requests accept up to 40 MiB of body data, 12 MiB for an individual image, and 36 MiB of new image data total. Reuse upload IDs for larger batches. The daily file quota counts a new file when the request begins processing it, including attempts that later fail. An issued upload ID belongs to the account and its test or live mode. Test upload IDs expire after 24 hours. Test jobs and their images are removed by scheduled cleanup. --- Source: https://garmo.studio/api/docs/catalog/ # Catalog GET/catalog/{kind} The ids that some edits take. kind is models, scenes or poses. Each item has id, name and a short description or preview. ## Models For model-swap. Garmo's models are listed by their name in lowercase (klara); the models you created in Garmo Studio appear as custom_ for your account only. The list changes as models are added, so read it from the API. ``` curl https://api.garmo.studio/v1/catalog/models \ -H "Authorization: Bearer $GARMO_API_KEY" ``` ``` const r = await fetch("https://api.garmo.studio/v1/catalog/models", { method: "GET", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}`, }, }); console.log(await r.json()); ``` ``` import os, requests r = requests.get( "https://api.garmo.studio/v1/catalog/models", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}"}, ) job = r.json() print(r.json()) ``` ``` true, CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY")], ]); $job = json_decode(curl_exec($ch), true); print_r($job); ``` ``` require "net/http" require "json" uri = URI("https://api.garmo.studio/v1/catalog/models") req = Net::HTTP::Get.new(uri) req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}" res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) } job = JSON.parse(res.body) pp job ``` ``` package main import ( "fmt" "io" "net/http" "os" ) func main() { req, _ := http.NewRequest("GET", "https://api.garmo.studio/v1/catalog/models", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("GARMO_API_KEY")) 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 { HttpRequest req = HttpRequest.newBuilder(URI.create("https://api.garmo.studio/v1/catalog/models")) .header("Authorization", "Bearer " + System.getenv("GARMO_API_KEY")) .GET() .build(); HttpResponse res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` ``` { "object": "list", "has_more": false, "data": [ { "id": "klara", "name": "Klara", "gender": "female", "custom": false, "preview_url": "https://garmo.studio/assets/model/woman/ai/klara-ai.jpg" }, { "id": "custom_57", "name": "Our model", "gender": "female", "custom": true, "preview_url": null } ] } ``` ## Scenes For background: white, beige, grey, sage, lobby, cafe, gallery, living, paris, terrace, coast, desert, lake, marble, linen, wood, stone. ## Poses For pose: standing, three, side, back, walking, seated, pockets, leaning. --- Source: https://garmo.studio/api/docs/account/ # Account GET/account The API credit balance, the key making the call and the limits that apply to it. ``` curl https://api.garmo.studio/v1/account \ -H "Authorization: Bearer $GARMO_API_KEY" ``` ``` const r = await fetch("https://api.garmo.studio/v1/account", { method: "GET", headers: { Authorization: `Bearer ${process.env.GARMO_API_KEY}`, }, }); console.log(await r.json()); ``` ``` import os, requests r = requests.get( "https://api.garmo.studio/v1/account", headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}"}, ) job = r.json() print(r.json()) ``` ``` true, CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY")], ]); $job = json_decode(curl_exec($ch), true); print_r($job); ``` ``` require "net/http" require "json" uri = URI("https://api.garmo.studio/v1/account") req = Net::HTTP::Get.new(uri) req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}" res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) } job = JSON.parse(res.body) pp job ``` ``` package main import ( "fmt" "io" "net/http" "os" ) func main() { req, _ := http.NewRequest("GET", "https://api.garmo.studio/v1/account", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("GARMO_API_KEY")) 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 { HttpRequest req = HttpRequest.newBuilder(URI.create("https://api.garmo.studio/v1/account")) .header("Authorization", "Bearer " + System.getenv("GARMO_API_KEY")) .GET() .build(); HttpResponse res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()); System.out.println(res.statusCode() + " " + res.body()); } } ``` ``` { "object": "account", "livemode": true, "api_credits": 482, "key": { "prefix": "gm_live_4e9P", "name": "Shop sync", "mode": "live" }, "tier": "medium", "limits": { "create_requests_per_minute": 20, "read_requests_per_minute": 300, "concurrent_images": 6, "images_per_request": 12 } } ``` --- Source: https://garmo.studio/api/docs/errors/ # Errors An error answers with an HTTP status and a body like this; code is stable, message is for people and may change: ``` { "error": { "code": "invalid_request", "message": "color_hex must be a color like \"#c8553d\".", "request_id": "req_XNnjm6TTkLMMNnVq" } } ``` Every answer also has an X-Request-Id header. Quote it to support@garmo.studio. - HTTP | Code | Meaning - 400 | invalid_request | A parameter is missing, unknown or out of range. The message names it. - 400 | invalid_image | The file is not a JPEG, PNG or WebP image, is over 40 megapixels, or an upload_id is not valid. - 400 | image_too_large | The image is larger than 12 MB. - 400 | image_unreachable | image_url could not be downloaded: not https, a private address, too many redirects, a timeout or a non-200 answer. - 401 | invalid_api_key | No key, an unknown key or a revoked key. - 402 | insufficient_credits | Not enough API credits for this request. Studio credits do not count. - 403 | api_not_enabled | Live keys need an API pack. Test keys work without one. - 403 | account_suspended | The account is suspended. - 403 | key_suspended | This key is suspended. - 404 | not_found | Unknown endpoint, or no such job for this account and key mode. - 409 | idempotency_conflict | The Idempotency-Key was already used for a different request: another endpoint, body or file. - 409 | idempotency_in_progress | A request with the same Idempotency-Key is still running. Retry after Retry-After seconds to get its job. - 413 | image_too_large | The body exceeds 40 MiB, a new image exceeds 12 MiB, or new image data exceeds 36 MiB in total. - 429 | rate_limited | Too many requests this minute for this key. Wait for Retry-After seconds. - 429 | concurrency_limited | Too many images rendering at once for this account. Wait for Retry-After seconds. - 429 | overloaded | Garmo is under heavy load. Wait for Retry-After seconds. - 500 | internal_error | Something went wrong on our side. - 503 | unavailable | The API or image generation is paused for a moment. Nothing was charged. ## What to retry - 429 and 503: wait for the Retry-After header, then retry with the same Idempotency-Key. - 500: retry once with the same Idempotency-Key; if it repeats, contact support with the request id. - 4xx other than 429: fix the request; retrying the same one gives the same answer. --- Source: https://garmo.studio/api/docs/rate-limits/ # Rate limits Three limits apply. Live keys get the limits of the largest API pack the account has bought. - Key | Create requests / min | Images at once | Reads / min - Test key | 5 | 2 | 60 - API 60 pack | 10 | 3 | 120 - API 220 pack | 20 | 6 | 300 - API 700 pack | 40 | 10 | 600 - API 3500 pack | 60 | 20 | 1200 - Create requests (edits, cancel, uploads) and reads (jobs, account, catalog) are counted per key and per minute. Over the limit: 429 rate_limited. - Images at once counts the images of your account still rendering, across all keys. A request that would go over it: 429 concurrency_limited. Send fewer images per request, or wait for jobs to finish. - When Garmo is under heavy load a request may get 429 overloaded even within your limits. ## Headers Every answer has X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds when the minute ends). A 429 also has Retry-After in seconds.