Skip to main content
POST
Analyze image for focal point, faces, and palette

Authorizations

Authorization
string
header
required

Dashboard-generated Convertly API key. Keys currently begin with cvly_.

Body

fileId
string<uuid>
required

Convertly Storage file ID to analyze.

refresh
boolean
default:false

When true, re-run analysis even if cached metadata exists.

Response

Analysis result

version
integer
required
Example:

1

width
integer
required
height
integer
required
focal
object
required
faces
object[]
required
palette
object
required

Dominant and population-sorted colour swatches.

analyzedAt
string<date-time>
required
cached
boolean

True when returned from stored file metadata without re-analysis.

Last modified on July 31, 2026