Generate variations

Generate creative variations of an image

curl --request POST \
  --url https://api.samsa.ai/public/v1/images/variations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "image": {
    "image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "https://cdn.example.com/photo.png",
    "base64": "<string>",
    "mime_type": "image/png"
  },
  "target": "everything",
  "creativity": "creative",
  "variation_instructions": "Try different background colors and lighting",
  "preservation_instructions": "Keep the product label and shape unchanged",
  "num_outputs": 1,
  "webhook_url": "https://example.com/webhooks/samsa"
}
'

import requests

url = "https://api.samsa.ai/public/v1/images/variations"

payload = {
    "image": {
        "image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "https://cdn.example.com/photo.png",
        "base64": "<string>",
        "mime_type": "image/png"
    },
    "target": "everything",
    "creativity": "creative",
    "variation_instructions": "Try different background colors and lighting",
    "preservation_instructions": "Keep the product label and shape unchanged",
    "num_outputs": 1,
    "webhook_url": "https://example.com/webhooks/samsa"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    image: {
      image_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      url: 'https://cdn.example.com/photo.png',
      base64: '<string>',
      mime_type: 'image/png'
    },
    target: 'everything',
    creativity: 'creative',
    variation_instructions: 'Try different background colors and lighting',
    preservation_instructions: 'Keep the product label and shape unchanged',
    num_outputs: 1,
    webhook_url: 'https://example.com/webhooks/samsa'
  })
};

fetch('https://api.samsa.ai/public/v1/images/variations', 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/variations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'image' => [
        'image_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'url' => 'https://cdn.example.com/photo.png',
        'base64' => '<string>',
        'mime_type' => 'image/png'
    ],
    'target' => 'everything',
    'creativity' => 'creative',
    'variation_instructions' => 'Try different background colors and lighting',
    'preservation_instructions' => 'Keep the product label and shape unchanged',
    'num_outputs' => 1,
    'webhook_url' => 'https://example.com/webhooks/samsa'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.samsa.ai/public/v1/images/variations"

	payload := strings.NewReader("{\n  \"image\": {\n    \"image_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"url\": \"https://cdn.example.com/photo.png\",\n    \"base64\": \"<string>\",\n    \"mime_type\": \"image/png\"\n  },\n  \"target\": \"everything\",\n  \"creativity\": \"creative\",\n  \"variation_instructions\": \"Try different background colors and lighting\",\n  \"preservation_instructions\": \"Keep the product label and shape unchanged\",\n  \"num_outputs\": 1,\n  \"webhook_url\": \"https://example.com/webhooks/samsa\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.samsa.ai/public/v1/images/variations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"image\": {\n    \"image_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"url\": \"https://cdn.example.com/photo.png\",\n    \"base64\": \"<string>\",\n    \"mime_type\": \"image/png\"\n  },\n  \"target\": \"everything\",\n  \"creativity\": \"creative\",\n  \"variation_instructions\": \"Try different background colors and lighting\",\n  \"preservation_instructions\": \"Keep the product label and shape unchanged\",\n  \"num_outputs\": 1,\n  \"webhook_url\": \"https://example.com/webhooks/samsa\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.samsa.ai/public/v1/images/variations")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"image\": {\n    \"image_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"url\": \"https://cdn.example.com/photo.png\",\n    \"base64\": \"<string>\",\n    \"mime_type\": \"image/png\"\n  },\n  \"target\": \"everything\",\n  \"creativity\": \"creative\",\n  \"variation_instructions\": \"Try different background colors and lighting\",\n  \"preservation_instructions\": \"Keep the product label and shape unchanged\",\n  \"num_outputs\": 1,\n  \"webhook_url\": \"https://example.com/webhooks/samsa\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "estimated_credits": 123
}

{
  "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"
  }
}

{
  "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"
  }
}

POST

images

variations

Generate creative variations of an image

curl --request POST \
  --url https://api.samsa.ai/public/v1/images/variations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "image": {
    "image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "https://cdn.example.com/photo.png",
    "base64": "<string>",
    "mime_type": "image/png"
  },
  "target": "everything",
  "creativity": "creative",
  "variation_instructions": "Try different background colors and lighting",
  "preservation_instructions": "Keep the product label and shape unchanged",
  "num_outputs": 1,
  "webhook_url": "https://example.com/webhooks/samsa"
}
'

import requests

url = "https://api.samsa.ai/public/v1/images/variations"

payload = {
    "image": {
        "image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "https://cdn.example.com/photo.png",
        "base64": "<string>",
        "mime_type": "image/png"
    },
    "target": "everything",
    "creativity": "creative",
    "variation_instructions": "Try different background colors and lighting",
    "preservation_instructions": "Keep the product label and shape unchanged",
    "num_outputs": 1,
    "webhook_url": "https://example.com/webhooks/samsa"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    image: {
      image_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      url: 'https://cdn.example.com/photo.png',
      base64: '<string>',
      mime_type: 'image/png'
    },
    target: 'everything',
    creativity: 'creative',
    variation_instructions: 'Try different background colors and lighting',
    preservation_instructions: 'Keep the product label and shape unchanged',
    num_outputs: 1,
    webhook_url: 'https://example.com/webhooks/samsa'
  })
};

fetch('https://api.samsa.ai/public/v1/images/variations', 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/variations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'image' => [
        'image_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'url' => 'https://cdn.example.com/photo.png',
        'base64' => '<string>',
        'mime_type' => 'image/png'
    ],
    'target' => 'everything',
    'creativity' => 'creative',
    'variation_instructions' => 'Try different background colors and lighting',
    'preservation_instructions' => 'Keep the product label and shape unchanged',
    'num_outputs' => 1,
    'webhook_url' => 'https://example.com/webhooks/samsa'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.samsa.ai/public/v1/images/variations"

	payload := strings.NewReader("{\n  \"image\": {\n    \"image_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"url\": \"https://cdn.example.com/photo.png\",\n    \"base64\": \"<string>\",\n    \"mime_type\": \"image/png\"\n  },\n  \"target\": \"everything\",\n  \"creativity\": \"creative\",\n  \"variation_instructions\": \"Try different background colors and lighting\",\n  \"preservation_instructions\": \"Keep the product label and shape unchanged\",\n  \"num_outputs\": 1,\n  \"webhook_url\": \"https://example.com/webhooks/samsa\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.samsa.ai/public/v1/images/variations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"image\": {\n    \"image_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"url\": \"https://cdn.example.com/photo.png\",\n    \"base64\": \"<string>\",\n    \"mime_type\": \"image/png\"\n  },\n  \"target\": \"everything\",\n  \"creativity\": \"creative\",\n  \"variation_instructions\": \"Try different background colors and lighting\",\n  \"preservation_instructions\": \"Keep the product label and shape unchanged\",\n  \"num_outputs\": 1,\n  \"webhook_url\": \"https://example.com/webhooks/samsa\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.samsa.ai/public/v1/images/variations")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"image\": {\n    \"image_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"url\": \"https://cdn.example.com/photo.png\",\n    \"base64\": \"<string>\",\n    \"mime_type\": \"image/png\"\n  },\n  \"target\": \"everything\",\n  \"creativity\": \"creative\",\n  \"variation_instructions\": \"Try different background colors and lighting\",\n  \"preservation_instructions\": \"Keep the product label and shape unchanged\",\n  \"num_outputs\": 1,\n  \"webhook_url\": \"https://example.com/webhooks/samsa\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "estimated_credits": 123
}

{
  "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"
  }
}

{
  "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"
  }
}

Generate creative variations of one source image. The call returns 202 Accepted with a job id; poll GET /images/variations/{id} for the result. The image takes exactly one of image_id, url, or base64 + mime_type. Requires the images.transform scope.

Example: one source per mode

curl -X POST https://api.samsa.ai/public/v1/images/variations \
  -H "Authorization: Bearer $SAMSA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "image": { "image_id": "123e4567-e89b-12d3-a456-426614174000" } }'

curl -X POST https://api.samsa.ai/public/v1/images/variations \
  -H "Authorization: Bearer $SAMSA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image": { "url": "https://cdn.example.com/photo.png" },
    "target": "object",
    "creativity": "subtle",
    "num_outputs": 4,
    "variation_instructions": "Try different background colors"
  }'

curl -X POST https://api.samsa.ai/public/v1/images/variations \
  -H "Authorization: Bearer $SAMSA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image": { "base64": "iVBORw0KGgoAAAANSUhEUg...", "mime_type": "image/png" },
    "preservation_instructions": "Keep the product shape unchanged",
    "webhook_url": "https://example.com/webhooks/samsa"
  }'

The 202 response is the async job handle:

202 Accepted

{
  "id": "c4d5e6f7-8a9b-4c1d-2e3f-4a5b6c7d8e9f",
  "status": "pending",
  "estimated_credits": 5
}

Send exactly one source mode in image. target — what the variations may change — is everything (default), person, object, or scene. creativity is subtle or creative (default). variation_instructions (what to change) and preservation_instructions (what to keep) are optional free text, ≤ 2000 characters each. num_outputs (1–4) defaults to 1 and each output is billed. There is no resolution parameter — the output resolution is inherited from the source.

Credits

Each output costs 5 credits at 1K, scaling with the source image’s resolution tier (1K ×1, 2K ×2, 4K ×4) and multiplied by num_outputs. See Pricing.

Errors

Status	Code	When
`402`	`insufficient_credits` / `insufficient_team_credits` / `insufficient_unallocated_credits`	The balance this credential can spend is below the job cost. Organizations with at least one active team get the team-aware codes instead of `insufficient_credits` (budget-exempt system organizations excepted). An operational failure inside the deduction can still surface as the generic `insufficient_credits`, whatever the regime.
`402`	`subscription_inactive`	The organization has no usable subscription.
`403`	`missing_scope`	Key lacks the `images.transform` scope.
`404`	`not_found`	The source `image_id` is unknown, or not owned by the API key’s creator — an image another member of your organization created is a `404` too.
`422`	`validation_error`	Zero/multiple source modes, bad `target`/`creativity`, or over-long instructions.
`429`	`rate_limited` / `too_many_active_jobs`	Per-key rate window or per-org concurrency cap exceeded.

Authorizations

Authorization

string

header

required

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

Body

application/json

POST /images/variations body (SAM-816 / S8.4 — ADR §8, §10).

Generate creative variations of ONE source image (the app's Gemini 3 Pro variations flow). The source is exactly one of image_id (an image in your organization's context), an https url, or base64+mime_type. The output resolution is inherited from the source (there is no resolution param); each output is billed at 5 x resolution_multiplier credits (1K:1x, 2K:2x, 4K:4x) where the multiplier is the source image's resolution tier. target and creativity are lowercase public aliases of the internal Gemini variation controls; num_outputs defaults to 1 (the app default is 4).

image

PublicImageEditSource · object

required

The source image: exactly one of image_id, url, or base64+mime_type.

Show child attributes

target

enum<string>

default:everything

What the variations may change: everything (default), person, object, or scene.

Available options:

everything,

person,

object,

scene

Example:

"everything"

creativity

enum<string>

default:creative

How far the variations may deviate from the source: subtle or creative (default).

Available options:

subtle,

creative

Example:

"creative"

variation_instructions

string | null

Optional free-text guidance for WHAT to change (<= 2000 chars).

Maximum string length: 2000

Example:

"Try different background colors and lighting"

preservation_instructions

string | null

Optional free-text guidance for WHAT to keep (<= 2000 chars).

Maximum string length: 2000

Example:

"Keep the product label and shape unchanged"

num_outputs

integer

default:1

Number of variations to generate (1-4). Defaults to 1 (the app default is 4); each output is billed.

Required range: 1 <= x <= 4

Example:

1

webhook_url

string | null

Optional https webhook notified once on terminal status (signed per the webhook signature scheme; see the webhooks docs).

Example:

"https://example.com/webhooks/samsa"

Response

Successful Response

Shared 202 body for the transform-op submits (SAM-813 / S8 wave).

Every POST /images/<op> returns the async job handle {id, status, estimated_credits}. The initial status is pending (the job is queued), with ONE exception: background-removals and vectorizations answer an owned-image_id cache hit (a ready result already exists for that image) with status: "completed" and estimated_credits: 0 — no new job is queued, the completed webhook event is emitted immediately for a supplied webhook_url, and the result is already available from the op's GET .../{id} endpoint. The other transform ops (img2img, variations, resizes, upscales) always start pending.

string<uuid>

required

The job id — poll the op's GET .../{id} endpoint.

status

enum<string>

required

Initial status: pending (job queued — enter the polling flow), or completed with estimated_credits: 0 when background-removals / vectorizations serve an owned-image cache hit (the result is immediately available).

Available options:

pending,

processing,

completed,

failed,

cancelled

Example:

"pending"

estimated_credits

integer

required

Credits this job is expected to cost — 0 on a cache-hit completed response.

Example:

5

Overview

Endpoints

Generate variations

Example: one source per mode

Credits

Errors

Authorizations

Body

Response

​Example: one source per mode

​Credits

​Errors

Authorizations

Body

Response

Example: one source per mode

Credits

Errors