Skip to main content
POST
/
api
/
v1
/
thumbnails
/
generate
Generate Thumbnail
curl --request POST \
  --url https://api.example.com/api/v1/thumbnails/generate \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=<string>' \
  --form 'url=<string>' \
  --form 'url_headers=<string>' \
  --form width=600 \
  --form height=400 \
  --form quality=95 \
  --form sync=true \
  --form 'webhook_url=<string>' \
  --form response_type=url
{
  "job_id": "job_abc123",
  "metadata": {
    "created_at": "2024-01-15T10:30:00Z",
    "file_category": "pdf",
    "file_size": 102400,
    "file_type": "pdf",
    "mime_type": "application/pdf",
    "original_filename": "document.pdf",
    "thumbnail_height": 400,
    "thumbnail_width": 600
  },
  "status": "completed",
  "success": true,
  "thumbnail_url": "https://storage.example.com/thumbnails/thumb_abc123.jpg"
}

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')