Skip to main content
POST
image.shadow.add

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
fileId
string
required

Id of an uploaded file holding the source image, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
removeBackground
boolean
default:true

Extract the subject before adding the shadow; false requires a source that preserves the original scene.

style
enum<string>
default:automatic

Shadow style; unsupported styles decline before processing. No shadow is an explicit choice.

Available options:
automatic,
car,
three-dimensional,
drop,
none,
soft,
hard,
floating,
preset-soft,
preset-hard,
controlled
opacity
default:auto

Darkness from 0 to 1, or automatic; zero is a valid transparent shadow.

Allowed value: "auto"
foreground
enum<string>
default:auto

Foreground category or automatic detection; not a person's identity.

Available options:
auto,
car,
product,
person,
animal,
graphic,
transportation
overrides
object[]

Explicit shadow choices per foreground category; unlisted categories have no shadow.

Required array length: 1 - 7 elements
softness
number

Softness override, zero to one, for controlled shadows.

Required range: 0 <= x <= 1
direction

Direction in degrees or a compass-like position relative to the subject.

spread

Shadow spread in degrees or a named length.

subjectPose

Subject pose in degrees or flat-lay/upright.

background
string

Optional solid background fill after extraction.

Pattern: ^(?:#[0-9a-fA-F]{6}(?:[0-9a-fA-F]{2})?|[0-9a-fA-F]{6}(?:[0-9a-fA-F]{2})?|aqua|black|blue|cyan|fuchsia|gray|green|lime|magenta|maroon|navy|olive|purple|red|silver|teal|white|yellow|transparent)$
output
object

Typed output settings; retaining embedded metadata requires an explicit choice.

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.