Skip to main content
POST
image.describe

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.

structured
boolean
default:false

Return structured scene elements instead of plain captions.

includeBoundingBoxes
boolean
default:true

Include normalized boxes in a structured scene.

includeStyle
boolean
default:false

Include style notes in a structured scene.

includeTags
boolean
default:false

Request scene tags when the source supports them.

Response

The result

descriptions
string[]
required

Plain descriptions, empty for structured scenes.

Maximum array length: 20
Required string length: 1 - 10000
scene
object

Structured scene when requested.