Skip to content

GET .../items/{itemId}/preview.{format}

Renders one item through a preset, as a quick image of the scene.

Method and path GET /v1/collections/{collectionId}/items/{itemId}/preview.{format}
Key needed
Response image/png, image/jpeg or image/webp
Lean OpenAPI getItemPreview
Full contract getItemPreview
Name In Meaning Default
collectionId path canonical id or alias
itemId path native item id
format path png, jpg or webp (ndvi: png or webp)
preset query true-color, false-color or ndvi true-color
max_size query long edge in pixels, 64 to 1,024 512
Terminal window
curl -s -o preview.png \
"https://api.satellitedata.net/v1/collections/sentinel-2-l2a/items/S2C_T15TVK_20260712T171233_L2A/preview.png?preset=false-color&max_size=1024" \
-H "X-API-Key: $SDN_API_KEY"

Responses are cacheable for a day and carry the credit line in X-Attribution.

Status Code When
400 invalid-parameter an unknown preset or query parameter, a format the preset does not serve, or max_size out of range
401 invalid-key no key or an unknown key
404 unknown-collection no such collection
404 not-found no such item
422 unknown-band the scene lacks an asset the preset needs
429 rate-limited, quota-exhausted over the rate or monthly limit
504 render-timeout the render ran past 29 seconds

Anonymous previews served from the CDN cache, with ETag validation.