Einen Hintergrundentfernungs-Job abrufen

Retrieve a background-removal job's status and result

curl --request GET \
  --url https://api.samsa.ai/public/v1/images/background-removals/{background_removal_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.samsa.ai/public/v1/images/background-removals/{background_removal_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.samsa.ai/public/v1/images/background-removals/{background_removal_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.samsa.ai/public/v1/images/background-removals/{background_removal_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.samsa.ai/public/v1/images/background-removals/{background_removal_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.samsa.ai/public/v1/images/background-removals/{background_removal_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "credits_used": 1,
  "image": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source_image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "mime_type": "<string>",
    "url": "<string>",
    "width": 123,
    "height": 123,
    "resolution_class": "2K",
    "model": "crystal"
  },
  "error": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "aspect_ratio"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "aspect_ratio"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "aspect_ratio"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "aspect_ratio"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "aspect_ratio"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "aspect_ratio"
  }
}

GET

images

background-removals

{background_removal_id}

Retrieve a background-removal job's status and result

curl --request GET \
  --url https://api.samsa.ai/public/v1/images/background-removals/{background_removal_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.samsa.ai/public/v1/images/background-removals/{background_removal_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.samsa.ai/public/v1/images/background-removals/{background_removal_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.samsa.ai/public/v1/images/background-removals/{background_removal_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.samsa.ai/public/v1/images/background-removals/{background_removal_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.samsa.ai/public/v1/images/background-removals/{background_removal_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "credits_used": 1,
  "image": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source_image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "mime_type": "<string>",
    "url": "<string>",
    "width": 123,
    "height": 123,
    "resolution_class": "2K",
    "model": "crystal"
  },
  "error": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "aspect_ratio"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "aspect_ratio"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "aspect_ratio"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "aspect_ratio"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "aspect_ratio"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "param": "aspect_ratio"
  }
}

Rufe den Status eines Hintergrundentfernungs-Jobs ab. Solange er pending oder processing ist, frage weiter ab; sobald completed, enthält die Antwort ein einzelnes image-Ergebnisobjekt — ein transparentes PNG mit einer presigned url, 24 Stunden gültig. Ein Cache-Treffer-Job wird bereits completed mit angehängtem Ergebnis geboren. Nur Jobs, die deine Organisation erstellt hat, sind sichtbar; jede andere id liefert 404 not_found. Erfordert den images.transform-Scope.

Beispiel: abgeschlossener Job

Das image ist ein abgeleitetes Formatergebnisobjekt; bei der Hintergrundentfernung sind model, width und height immer null. Dieses Beispiel ist ein Cache-Treffer, daher ist credits_used 0 (ein normaler Miss zeigt 1):

200 OK

{
  "id": "f7a8b9c0-1d2e-4f3a-4b5c-6d7e8f9a0b1c",
  "status": "completed",
  "created_at": "2026-07-18T10:12:00Z",
  "credits_used": 0,
  "image": {
    "id": "3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f",
    "source_image_id": "123e4567-e89b-12d3-a456-426614174000",
    "format_type": "background_removal",
    "mime_type": "image/png",
    "url": "https://cdn.samsa.ai/user-.../no-bg.png?X-Amz-Signature=...",
    "width": null,
    "height": null,
    "resolution_class": null,
    "model": null
  },
  "error": null
}

Übergib eine webhook_url bei der ursprünglichen Hintergrundentfernungs-Anfrage, um statt Polling einen signierten Callback zu erhalten — bei einem Cache-Treffer feuert das completed-Event sofort. Siehe Webhooks.

Autorisierungen

Authorization

string

header

erforderlich

Organization API key as a bearer token: Authorization: Bearer samsa_sk_....

Pfadparameter

background_removal_id

string<uuid>

erforderlich

Antwort

Successful Response

GET /images/background-removals/{id} body (SAM-820 / S8.8 — ADR §7.2).

The standard async-job envelope plus ONE nullable image result object (an image_formats derivative — a transparent PNG — built by the S8.2 egress builder; model/width/height are always null for background removal). created_at is the job's submit time from the credit ledger (the image_generation_tasks table has no created_at column). A cache-hit job is born completed with a frozen result; a normal job progresses pending → processing → completed/failed.

string<uuid>

erforderlich

status

enum<string>

erforderlich

pending, processing, completed, failed, or cancelled.

Verfügbare Optionen:

pending,

processing,

completed,

failed,

cancelled

Beispiel:

"completed"

created_at

string<date-time>

erforderlich

When the job was submitted.

credits_used

integer | null

Net credits charged for this job, after any refunds (0 for a cache hit).

Beispiel:

1

image

PublicImageFormatResult · object | null

The produced transparent PNG (presigned URL); null until completed.

Show child attributes

error

string | null

Failure detail when status is failed; otherwise null.

Übersicht

Endpunkte

Einen Hintergrundentfernungs-Job abrufen

Beispiel: abgeschlossener Job

Autorisierungen

Pfadparameter

Antwort

​Beispiel: abgeschlossener Job

Autorisierungen

Pfadparameter

Antwort

Beispiel: abgeschlossener Job