Skip to main content
POST
image.subject.outline

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}$
colour
string
required

Outline colour; eight-digit hex includes alpha.

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)$
width
number
default:0.03

Outline thickness as a fraction of image size, 0–0.1; default 0.03.

Required range: 0 <= x <= 0.1
blur
number
default:0

Outline blur radius as a fraction of image size, 0–0.025; default 0.

Required range: 0 <= x <= 0.025
removeBackground
boolean
default:true

Extract the subject when true; false preserves its original background.

background
string

Solid or transparent background after extraction; requires removeBackground true.

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)$
layout
object

Subject framing and canvas layout. Unsupported combinations decline before processing.

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.