Models

Requests

AddImageDatasetRequest

Request to add an image dataset

type: Literal['image']

urls: list[str]

bands: list[str] | None

groupby: str | None

Read-only data descriptor used to emit a runtime deprecation warning before accessing a deprecated field.

Variables

• msg – The deprecation message to be emitted.

• wrapped_property – The property instance if the deprecated field is a computed field, or None.

• field_name – The name of the field being deprecated.

filename_date_pattern: str | None

filename_band_pattern: list[FilenameBandPattern] | None

labels: list[DatasetLabel] | None

Read-only data descriptor used to emit a runtime deprecation warning before accessing a deprecated field.

Variables

• msg – The deprecation message to be emitted.

• wrapped_property – The property instance if the deprecated field is a computed field, or None.

• field_name – The name of the field being deprecated.

AddVectorDatasetRequest

Request to add a vector dataset

type: Literal['vector']

url: str

coordinate_precision: Literal['auto', '1250m', '600m', '300m', '150m', '80m', '40m', '20m', '10m', '5m', '2m', '1m', '50cm', '25cm', '15cm', '8cm']

labels: list[DatasetLabel] | None

Read-only data descriptor used to emit a runtime deprecation warning before accessing a deprecated field.

Variables

• msg – The deprecation message to be emitted.

• wrapped_property – The property instance if the deprecated field is a computed field, or None.

• field_name – The name of the field being deprecated.

AddZarrDatasetRequest

Request to add a Zarr dataset

type: Literal['zarr']

urls: list[str]

rename: dict[str, str] | None

check_only_one_url_for_now

check_only_one_url_for_now() → AddZarrDatasetRequest

Return type

AddZarrDatasetRequest

labels: list[DatasetLabel] | None

Read-only data descriptor used to emit a runtime deprecation warning before accessing a deprecated field.

Variables

• msg – The deprecation message to be emitted.

• wrapped_property – The property instance if the deprecated field is a computed field, or None.

• field_name – The name of the field being deprecated.

AddTileServerDatasetRequest

type: Literal['tileserver']

url: str

labels: list[DatasetLabel] | None

Read-only data descriptor used to emit a runtime deprecation warning before accessing a deprecated field.

Variables

• msg – The deprecation message to be emitted.

• wrapped_property – The property instance if the deprecated field is a computed field, or None.

• field_name – The name of the field being deprecated.

AddDatasetRequest

alias of AddImageDatasetRequest | AddZarrDatasetRequest | AddVectorDatasetRequest | AddTileServerDatasetRequest

Responses

AddDatasetResponse

dataset_id: UUID

Dataset ID of the newly created dataset version

dataset_version_id: UUID

Dataset Version ID of the newly created dataset version

DeleteDatasetResponse

dataset_id: UUID

Dataset ID of the deleted dataset

dataset_version_id: UUID

Dataset Version ID of the deletion marker version

DatasetResponse

dataset_id: UUID

Dataset ID of the dataset

dataset_version_id: UUID

ID for the current version of the dataset

name: str

Name of the dataset

type: DatasetType

Type of the dataset, either raster or vector

labels: list[DatasetLabel]

User-defined labels for the dataset. Superseded by tags.

Type

Deprecated

tags: dict[str, str]

User-defined tags for the dataset

variables: dict[str, Variable]

Estimated statistics for each variable in the dataset, useful for visualization

created_at: AwareDatetime

Timestamp of when the dataset was created

visualization_optimization: Optimization

Status of the visualization optimization for faster visualization

pixel_info_optimizations: dict[str, Optimization]

Status of the pixel info optimizations for faster pixel info retrieval

dynamic_tile_server: TileServer

Dynamic tile server for fast visualization

optimized_tile_server: TileServer | None

Optimized tile server for fast visualization

ListDatasetResponse

Single entry in the list of datasets with a subset of information

dataset_id: UUID

Dataset ID of the dataset

dataset_version_id: UUID

ID for the current version of the dataset

name: str

Name of the dataset

type: DatasetType

Type of the dataset, either raster or vector

labels: list[DatasetLabel]

User-defined labels for the dataset. Superseded by tags.

Type

Deprecated

tags: dict[str, str]

User-defined tags for the dataset

created_at: AwareDatetime

Timestamp of when the dataset was created

updated_at: AwareDatetime

Timestamp of when the dataset was last updated

PaginatedListDatasetResponse

Paginated list of datasets with cursor-based pagination

data: list[ListDatasetResponse]

List of datasets

next_cursor: str | None

Opaque cursor token for fetching the next page

VersionCheckResponse

is_supported: bool

newest_supported_version: int

is_deprecated: bool

will_be_removed_after: date | None

deprecation_message: str | None

Other Models

DatasetType

RASTER = 'raster'

VECTOR = 'vector'

DatasetLabel

User-defined label for a dataset

name: str

Name of the label. Can be any string.

value: str

Value of the label. Can be any string.

SimpleDatasetMetadata

Simplified metadata with only essential fields

description: str | None

thumbnail_url: str | None

attributes: list[DatasetLabel]

license: str | None

FilenameBandPattern

Pattern for mapping filename patterns to band names

pattern: str

band: str | None

band_mapping: dict[int, str] | None

DatasetOverviewsStatus

status: str

Status of the dataset overview generation. One of:

• “not_started”: Overview generation has not started yet

• “pending”: Overview generation is pending

• “running”: Overview generation is running

• “success”: Overview generation has completed successfully

• “error”: Overview generation has failed

updated_at: datetime | None

Timestamp of the last update to the status

OptimizationStatus

alias of Literal[‘not_started’, ‘pending’, ‘running’, ‘success’, ‘error’]

Optimization

status: Literal['not_started', 'pending', 'running', 'success', 'error']

Status of the optimization. One of:

• “not_started”: Optimization has not started yet

• “pending”: Optimization is pending

• “running”: Optimization is running

• “success”: Optimization has completed successfully

• “error”: Optimization has failed

updated_at: datetime | None

Timestamp of the last update to the status

TileServer

tile_url: str

Tileserver URL to be used in an application

pixel_url: str

Pixel info URL to be used in an application

min_zoom: int

Minimum zoom level supported by the tile server

max_zoom: int

Maximum zoom level supported by the tile server

Variable

Estimated statistics for a variable in the dataset, useful for visualization

sampled_min: float

Estimated minimum value in the dataset

sampled_max: float

Estimated maximum value in the dataset