Skip to main content
POST
image.inspect

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 image to inspect, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
checks
enum<string>[]
required

Only these requested image checks are computed and returned.

Required array length: 1 - 17 elements
Available options:
caption,
metadata,
clothing,
garmentColour,
garmentCategory,
syntheticLikelihood,
hateLikelihood,
violenceLikelihood,
addedTextLikelihood,
imageQuality,
humanContentLikelihood,
ecommerceProduct,
foodOrBeverage,
cropped,
fashionSimilarity,
foodMismatch,
productShadow
reference
object

Reference image required for fashion similarity or food mismatch.

colours
object[]

Your colour taxonomy; required only with garmentColour.

Required array length: 1 - 1000 elements
categories
object[]

Your category tree; required only with garmentCategory. Unique codes, valid parents and no cycles.

Required array length: 1 - 2000 elements

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.