Skip to content
← Retour à l’index API
GET /screenshot/thumbnail

Retrieve thumbnail image

Options

Les options sont regroupées pour faciliter la lecture, sur le modèle d’une documentation centrée sur les paramètres.

App

bottom

query integer Facultatif

Exemple : 0

Number of pixels to remove from the bottom edge. The combined top and bottom values must be less than the source image height.

filename

query string Facultatif

Optional filename for Content-Disposition attachment

id

query integer Obligatoire

Screenshot ID

left

query integer Facultatif

Exemple : 0

Number of pixels to remove from the left edge. The combined left and right values must be less than the source image width.

quality

query integer Facultatif

Exemple : 100

JPEG/WEBP quality (1-100)

ratio

query enum(fit, fill) Facultatif

Exemple : fit

Aspect ratio mode: fit (preserve) or fill (crop)

right

query integer Facultatif

Exemple : 0

Number of pixels to remove from the right edge. The combined left and right values must be less than the source image width.

scale

query number Facultatif

Exemple : 1

Scale factor

shot

query integer Facultatif

Exemple : 1

Which screenshot if multiple requested

top

query integer Facultatif

Exemple : 0

Number of pixels to remove from the top edge. The combined top and bottom values must be less than the source image height.

zoom

query integer Facultatif

Exemple : 100

Zoom percentage

Output & Format

format

query enum(png, jpeg, webp) Facultatif

Exemple : png

Image format (`webmp` alias is accepted and normalized to `webp`)

height

query integer Facultatif

Thumbnail height in pixels

width

query integer Facultatif

Thumbnail width in pixels

Réponses

200

Thumbnail image

Aucun exemple JSON fourni dans OpenAPI.

400

Invalid parameters

{
  "error": "Request validation failed",
  "code": "VALIDATION_ERROR",
  "fields": {
    "url": [
      "URL is required"
    ],
    "country": [
      "Country code must be ISO 3166-1 alpha-2"
    ]
  }
}
401

Unauthorized

{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}
404

Screenshot not found, not ready, or no image was captured

{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}
500

Server error

{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}