Skip to main content
POST
Generate Thumbnail

Headers

X-API-Key
string

Body

multipart/form-data
file
string | null

File to generate thumbnail from

url
string | null

URL to fetch file from

url_headers
string | null

JSON-encoded headers for URL auth

width
integer
default:600

Max thumbnail width

Required range: 50 <= x <= 2000
height
integer
default:400

Max thumbnail height

Required range: 50 <= x <= 2000
quality
integer
default:95

JPEG quality

Required range: 1 <= x <= 100
sync
boolean
default:true

Wait for result or return job ID

webhook_url
string | null

Webhook URL for async completion

response_type
string
default:url

Response type: 'url' or 'base64'

Response

Successful Response

Response for a completed thumbnail generation.

job_id
string
required

Unique job identifier

metadata
ThumbnailMetadata · object
required

Thumbnail metadata

success
boolean
default:true
status
enum<string>
default:completed

Job processing status.

Available options:
pending,
processing,
completed,
failed
thumbnail_url
string | null

URL to the thumbnail image

thumbnail_base64
string | null

Base64-encoded thumbnail (if response_type='base64')