Skip to main content
POST
/
api
/
images
/
analyze
Analyze image for focal point, faces, and palette
curl --request POST \
  --url https://convertly.sh/api/images/analyze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "version": 1,
  "width": 123,
  "height": 123,
  "focal": {
    "suggested": {
      "x": 123,
      "y": 123,
      "confidence": 123
    },
    "crop": {
      "left": 123,
      "top": 123,
      "width": 123,
      "height": 123
    }
  },
  "faces": [
    {
      "x": 123,
      "y": 123,
      "width": 123,
      "height": 123,
      "confidence": 123
    }
  ],
  "palette": {},
  "analyzedAt": "2023-11-07T05:31:56Z",
  "cached": true
}

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.