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 |
|---|---|
idstring | The job id, job_ plus 20 characters. |
objectstring | Always "job". |
toolstring | The endpoint that made it: generate, remove-background, background, color, pose, model-swap, ghost-mannequin or upscale. |
statusstring | "processing", then "completed" (at least one output succeeded), "failed" or "canceled". |
livemodeboolean | false for jobs made with a test key. |
outputsarray | 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_chargedinteger | Credits taken when the job was created (0 for a test key). |
credits_refundedinteger | Credits given back for outputs that failed or were canceled. |
metadataobject | Your metadata, or null. |
created_atstring | ISO 8601, UTC. |
completed_atstring | 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())<?php
$ch = curl_init("https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => 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 jobpackage 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<String> 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 |
|---|---|
limitinteger | Between 1 and 100. Default 20. |
starting_afterstring | A job id: list the jobs after it. |
statusstring | 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())<?php
$ch = curl_init("https://api.garmo.studio/v1/jobs?limit=20&status=completed");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => 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 jobpackage 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<String> 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())<?php
$ch = curl_init("https://api.garmo.studio/v1/jobs/job_8Kq2xV7mPz4LtR9wNc3B/cancel");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => 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 jobpackage 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<String> res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString());
System.out.println(res.statusCode() + " " + res.body());
}
}



