Resize an image

Resize an image to a new aspect ratio (server-side outpaint)

curl --request POST \
  --url https://api.samsa.ai/public/v1/images/resizes \
  --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"
  },
  "aspect_ratio": "<string>",
  "resolution": "1K",
  "num_outputs": 1,
  "prompt": "",
  "placement": {
    "gravity": "center",
    "scale": 1
  },
  "webhook_url": "https://example.com/webhooks/samsa"
}
'

import requests

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

payload = {
    "image": {
        "image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "https://cdn.example.com/photo.png",
        "base64": "<string>",
        "mime_type": "image/png"
    },
    "aspect_ratio": "<string>",
    "resolution": "1K",
    "num_outputs": 1,
    "prompt": "",
    "placement": {
        "gravity": "center",
        "scale": 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'
    },
    aspect_ratio: '<string>',
    resolution: '1K',
    num_outputs: 1,
    prompt: '',
    placement: {gravity: 'center', scale: 1},
    webhook_url: 'https://example.com/webhooks/samsa'
  })
};

fetch('https://api.samsa.ai/public/v1/images/resizes', 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/resizes",
  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'
    ],
    'aspect_ratio' => '<string>',
    'resolution' => '1K',
    'num_outputs' => 1,
    'prompt' => '',
    'placement' => [
        'gravity' => 'center',
        'scale' => 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/resizes"

	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  \"aspect_ratio\": \"<string>\",\n  \"resolution\": \"1K\",\n  \"num_outputs\": 1,\n  \"prompt\": \"\",\n  \"placement\": {\n    \"gravity\": \"center\",\n    \"scale\": 1\n  },\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/resizes")
  .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  \"aspect_ratio\": \"<string>\",\n  \"resolution\": \"1K\",\n  \"num_outputs\": 1,\n  \"prompt\": \"\",\n  \"placement\": {\n    \"gravity\": \"center\",\n    \"scale\": 1\n  },\n  \"webhook_url\": \"https://example.com/webhooks/samsa\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"aspect_ratio\": \"<string>\",\n  \"resolution\": \"1K\",\n  \"num_outputs\": 1,\n  \"prompt\": \"\",\n  \"placement\": {\n    \"gravity\": \"center\",\n    \"scale\": 1\n  },\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

resizes

Resize an image to a new aspect ratio (server-side outpaint)

curl --request POST \
  --url https://api.samsa.ai/public/v1/images/resizes \
  --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"
  },
  "aspect_ratio": "<string>",
  "resolution": "1K",
  "num_outputs": 1,
  "prompt": "",
  "placement": {
    "gravity": "center",
    "scale": 1
  },
  "webhook_url": "https://example.com/webhooks/samsa"
}
'

import requests

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

payload = {
    "image": {
        "image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "https://cdn.example.com/photo.png",
        "base64": "<string>",
        "mime_type": "image/png"
    },
    "aspect_ratio": "<string>",
    "resolution": "1K",
    "num_outputs": 1,
    "prompt": "",
    "placement": {
        "gravity": "center",
        "scale": 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'
    },
    aspect_ratio: '<string>',
    resolution: '1K',
    num_outputs: 1,
    prompt: '',
    placement: {gravity: 'center', scale: 1},
    webhook_url: 'https://example.com/webhooks/samsa'
  })
};

fetch('https://api.samsa.ai/public/v1/images/resizes', 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/resizes",
  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'
    ],
    'aspect_ratio' => '<string>',
    'resolution' => '1K',
    'num_outputs' => 1,
    'prompt' => '',
    'placement' => [
        'gravity' => 'center',
        'scale' => 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/resizes"

	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  \"aspect_ratio\": \"<string>\",\n  \"resolution\": \"1K\",\n  \"num_outputs\": 1,\n  \"prompt\": \"\",\n  \"placement\": {\n    \"gravity\": \"center\",\n    \"scale\": 1\n  },\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/resizes")
  .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  \"aspect_ratio\": \"<string>\",\n  \"resolution\": \"1K\",\n  \"num_outputs\": 1,\n  \"prompt\": \"\",\n  \"placement\": {\n    \"gravity\": \"center\",\n    \"scale\": 1\n  },\n  \"webhook_url\": \"https://example.com/webhooks/samsa\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"aspect_ratio\": \"<string>\",\n  \"resolution\": \"1K\",\n  \"num_outputs\": 1,\n  \"prompt\": \"\",\n  \"placement\": {\n    \"gravity\": \"center\",\n    \"scale\": 1\n  },\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"
  }
}

Resize one source image to a new aspect_ratio. Resize is a server-side outpaint: the backend renders the composition and mask from your source at the target ratio and fills the newly exposed canvas with a style-matched extension. The call returns 202 Accepted with a job id; poll GET /images/resizes/{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/resizes \
  -H "Authorization: Bearer $SAMSA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image": { "image_id": "123e4567-e89b-12d3-a456-426614174000" },
    "aspect_ratio": "16:9"
  }'

curl -X POST https://api.samsa.ai/public/v1/images/resizes \
  -H "Authorization: Bearer $SAMSA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image": { "url": "https://cdn.example.com/portrait.png" },
    "aspect_ratio": "1:1",
    "resolution": "2K",
    "placement": { "gravity": "top", "scale": 0.8 }
  }'

curl -X POST https://api.samsa.ai/public/v1/images/resizes \
  -H "Authorization: Bearer $SAMSA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image": { "base64": "iVBORw0KGgoAAAANSUhEUg...", "mime_type": "image/png" },
    "aspect_ratio": "21:9",
    "num_outputs": 2,
    "prompt": "extend the mountain range on both sides",
    "webhook_url": "https://example.com/webhooks/samsa"
  }'

The 202 response is the async job handle:

202 Accepted

{
  "id": "e6f7a8b9-0c1d-4e2f-3a4b-5c6d7e8f9a0b",
  "status": "pending",
  "estimated_credits": 5
}

aspect_ratio is required and one of 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16. resolution (1K default, 2K, 4K) is provider metadata that scales credits — the canvas is always rendered at a 1024px max edge. num_outputs (1–4) defaults to 1 and each output is billed. prompt is optional guidance for the newly generated area (validated when non-empty). placement positions the source on the target canvas: gravity is one of center (default), top, bottom, left, right, top_left, top_right, bottom_left, bottom_right; scale is in (0, 1] (default 1.0 = maximum contain-fit).

Empty-mask no-op. When the requested aspect_ratio + placement leave (almost) no new area to generate — e.g. the source already matches the target ratio at scale = 1 — and no prompt is given, the job skips the model, returns the flattened composition, and refunds the unused outputs. It still completes.

Credits

Each output costs 5 credits at 1K, scaling with resolution (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, missing/invalid `aspect_ratio`, bad `placement`, a policy-violating `prompt`, or a source raster above 33,554,432 pixels (32 MP, width × height), which is rejected with `param: image` before any rendering.
`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/resizes body (SAM-818 / S8.6 — ADR §8, §10).

Resize = server-side outpaint: the backend renders the composition + mask from your source at the target aspect_ratio and fills the newly exposed canvas with a style-matched extension. The source is exactly one of image_id (an image in your organization's context), an https url, or base64+mime_type. aspect_ratio is REQUIRED (validated against the resize engine's supported list). num_outputs defaults to 1; each output is billed at 5 x resolution_multiplier credits (1K:1x, 2K:2x, 4K:4x).

Empty-mask no-op: when the requested aspect_ratio + placement leave (almost) no new area to generate (e.g. the source already matches the target ratio at scale=1) and no prompt is given, the job SKIPS the model, returns the flattened composition, and REFUNDS the unused outputs — it still completes.

image

PublicImageEditSource · object

required

The source image: exactly one of image_id, an https url, or base64+mime_type. The source raster must be at most 33,554,432 pixels (32 MP, width x height) — a larger source returns 422 with param: image before any rendering. The composition canvas is at most 1024px per edge, so higher-resolution sources gain no output detail.

Show child attributes

aspect_ratio

string

required

Target aspect ratio (REQUIRED) — one of: 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16.

Example:

"16:9"

resolution

string

default:1K

Provider resolution tier — 1K (default), 2K, or 4K. The canvas is always rendered at a 1024px max edge (per S8.5); the tier is provider metadata that scales credits 1K:1x, 2K:2x, 4K:4x per output.

Example:

"1K"

num_outputs

integer

default:1

Number of images to generate (1-4). Defaults to 1; each output is billed.

Required range: 1 <= x <= 4

Example:

1

prompt

string

default:""

Optional instruction for the newly generated area. When non-empty it runs the app's prompt validation (rejects empty / malformed / policy-violating prompts with a 422).

Example:

"extend the beach and the ocean horizon naturally"

placement

PublicResizePlacement · object | null

Optional placement of the source on the target canvas (gravity + scale). Defaults to centered, maximum contain-fit.

Show child attributes

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

Resize an image

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