Skip to main content
POST
image.ad.resize

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
source
object
required

An image you uploaded; at most 20 MB.

targetSize
object
required

Exact output dimensions; sources may decline unsupported sizes.

placement
enum<string>

Optional placement whose safe area should be preserved.

Available options:
google,
tiktok,
meta-stories,
meta-reels,
meta,
snapchat
prompt
string

Image instructions, up to 4000 characters.

Required string length: 1 - 4000
quality
enum<string>
default:low

Detail level. High is an explicit, dearer choice. Default low.

Available options:
low,
medium,
high
count
integer
default:1

Number of outputs, 1 to 4. Default 1.

Required range: 1 <= x <= 4

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.