Skip to main content
POST
Resize an image to a new aspect ratio (server-side outpaint)
Redimensionne une image source vers un nouveau aspect_ratio. Le redimensionnement est un outpainting côté serveur : le backend rend la composition et le masque à partir de ta source au ratio cible et remplit la nouvelle toile exposée avec une extension assortie au style. L’appel renvoie 202 Accepted avec un id de job ; interroge GET /images/resizes/{id} pour le résultat. L’image prend exactement un de image_id, url ou base64 + mime_type. Requiert le scope images.transform.

Exemple : une source par mode

La réponse 202 est le handle de job asynchrone :
202 Accepted
aspect_ratio est requis et l’un de 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16. resolution (1K défaut, 2K, 4K) est une métadonnée fournisseur qui met à l’échelle les credits — la toile est toujours rendue avec un bord maximal de 1024px. num_outputs (1 à 4) vaut 1 par défaut et chaque sortie (output) est facturée. prompt est une instruction facultative pour la zone nouvellement générée (validée si non vide). placement positionne la source sur la toile cible : gravity est l’un de center (défaut), top, bottom, left, right, top_left, top_right, bottom_left, bottom_right ; scale est dans (0, 1] (défaut 1.0 = contain-fit maximal).
No-op masque vide. Quand l’aspect_ratio + placement demandés ne laissent (presque) aucune nouvelle zone à générer — p. ex. la source correspond déjà au ratio cible à scale = 1 — et qu’aucun prompt n’est fourni, le job saute le modèle, renvoie la composition aplatie et rembourse les sorties inutilisées. Il completes tout de même.

Credits

Chaque sortie (output) coûte 5 credits en 1K, en fonction de la résolution (1K ×1, 2K ×2, 4K ×4) et multiplié par num_outputs. Voir Tarifs.

Erreurs

Autorisations

Authorization
string
header
requis

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

Corps

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
requis

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.

aspect_ratio
string
requis

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.

Exemple:

"16:9"

resolution
string
défaut: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.

Exemple:

"1K"

num_outputs
integer
défaut:1

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

Plage requise: 1 <= x <= 4
Exemple:

1

prompt
string
défaut:""

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).

Exemple:

"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.

webhook_url
string | null

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

Exemple:

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

Réponse

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.

id
string<uuid>
requis

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

status
enum<string>
requis

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).

Options disponibles:
pending,
processing,
completed,
failed,
cancelled
Exemple:

"pending"

estimated_credits
integer
requis

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

Exemple:

5