sdk.aoi.get()

Get AOI details.

Get the metadata about the specified AOIs. Setting the verbose flag will also include the geometry bytes in WKT format.

Parameters

ids (List[str]) - List of AOI IDs to retrieve
[Optional] verbose (bool) - If True, include geometry in WKT format (default: False)

Returns

List[AOIVersion] - List of AOI version objects

Example(s)

# Get AOI metadata
aois = await sdk.aoi.get(ids=["aoi-uuid-1", "aoi-uuid-2"])

# Get AOI metadata with geometry
aois = await sdk.aoi.get(
    ids=["aoi-uuid-1", "aoi-uuid-2"],
    verbose=True
)

# Output (List[AOIVersion])
[
    aoi_id: "aoi-uuid-1"
    version: 1
    name: "San Francisco Bay"
    category: "port"
    geom_wkt: "POLYGON((-122.5 37.7, -122.5 37.8, -122.4 37.8, -122.4 37.7, -122.5 37.7))"
    ,
    aoi_id: "aoi-uuid-2"
    version: 1
    name: "Los Angeles Harbor"
    category: "port"
]