Skip to main content
POST
cURL

Authorizations

X-Api-Key
string
header
required

Your Pikzels API key (prefix: pkz_)

Body

application/json
image_url
string
required

HTTPS URL -- provide this or image_base64. A YouTube watch URL resolves to that video's current thumbnail

Pattern: ^https://\S+$
image_base64
string

Base64 data URL -- provide this or image_url

Pattern: ^data:image/[a-zA-Z0-9.+-]+;base64,
title
string

Optional title for context

Maximum string length: 200

Response

Success

main_score
number
required

Overall score 0-100

request_id
string
required
subscores
object
required
suggestion
string | null
required