Tiler Previews - Get

Service:: Planetary Computer

API Version:: 2025-04-30-preview

Create preview of a dataset.

GET https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/data/collections/{collectionId}/items/{itemId}/preview?api-version=2025-04-30-preview

With optional parameters:

GET https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/data/collections/{collectionId}/items/{itemId}/preview?api-version=2025-04-30-preview&assets={assets}&expression={expression}&assetBidx={assetBidx}&asset_as_band={asset_as_band}&nodata={nodata}&unscale={unscale}&algorithm={algorithm}&algorithm_params={algorithm_params}&format={format}&color_formula={color_formula}&dst-crs={dst-crs}&resampling={resampling}&max_size={max_size}&height={height}&width={width}&rescale={rescale}&colormap_name={colormap_name}&colormap={colormap}&return_mask={return_mask}

URI Parameters

Name	In	Required	Type	Description
collectionId	path	True	string maxLength: 500 pattern: .*	STAC Collection Identifier
itemId	path	True	string maxLength: 500 pattern: .*	STAC Item Identifier
api-version	query	True	string minLength: 1	The API version to use for this operation.
algorithm	query		Algorithm	Algorithm name
algorithm_params	query		string	Algorithm parameter
asset_as_band	query		boolean	Asset as Band
assetBidx	query		string[]	Per asset band indexes (coma separated indexes)
assets	query		string[]	Asset's names.
color_formula	query		string	rio-color formula (info: https://github.com/mapbox/rio-color)
colormap	query		string	JSON encoded custom Colormap
colormap_name	query		ColorMapNames	Colormap name
dst-crs	query		string	Output Coordinate Reference System.
expression	query		string	Band math expression between assets
format	query		ImageType	Output format for the tile or image (e.g., png, jpeg, webp).
height	query		integer (int32)	Height in pixels for the output image
max_size	query		integer (int32)	Image output size limit if width and height limits are not set.
nodata	query		number (float)	Overwrite internal Nodata value
resampling	query		Resampling	Resampling method.
rescale	query		string[]	comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
return_mask	query		boolean	Add mask to the output data.
unscale	query		boolean	Apply internal Scale or Offset
width	query		integer (int32)	Width in pixels for the output image

Responses

Name	Type	Description
200 OK	file	Return an image. Media Types: "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json"
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Media Types: "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json" Headers x-ms-error-code: string

Name

Type

Description

200 OK

file

Return an image.

Media Types: "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json"

Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Media Types: "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json"

Headers

x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://geocatalog.spatio.azure.com/.default

Examples