Sign in

v1

latestOpenAPI 3.0.02026-08-0455133277.1 KB
Visualizations

Create a new visualization

Creates a new visualization for an AOI using the specified index and assets. For preset index types, both dynamic and theoretical legend metadata are auto-computed. For custom index types with expression_type INDEX, only dynamic legend metadata is computed. For custom index types with expression_type composite or grayscale, no legend metadata is generated.

post/v0/aois/{aoi_id}/visualizations

Path parameters

aoi_idstring required

AOI ID

Request body

index_idstring required

UUID of the index to use for this visualization

src_asset_idsstring[]

Optional list of source asset IDs to include in the visualization

resolutionnumber

Optional resolution override. If not provided, defaults to the satellite's default resolution

Example request

{
  "index_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "src_asset_ids": [
    "e3a671ad-5381-4413-8c1c-bc4e1ccaff45",
    "90d63531-5f54-4704-a4b0-7bb92ae08f23"
  ],
  "resolution": 10
}

Response

Created

aoi_idstring
created_atstring
expressionstring
expression_type'composite' | 'index' | 'grayscale'
idstring
index_idstring
index_namestring
progressinteger
rescaleinteger[]
status'creating' | 'success' | 'failed' | 'partial_success'
tenant_idstring
type'custom'
updated_atstring
user_idstring

Example response

{
  "aoi_id": "e9767554-550e-4464-a677-b8cf096073ab",
  "assets": [
    {
      "aoi_id": "e9767554-550e-4464-a677-b8cf096073ab",
      "band_list": [
        "B01",
        "B02"
      ],
      "centroid": [
        77.55,
        12.95
      ],
      "created_at": "2022-11-14 12:55:49.125928+00:00",
      "date": "2022-11-14",
      "description": "This asset is mosaic file",
      "geometry": {
        "type": "Polygon"
      },
      "id": "e9767554-550e-4464-a677-b8cf096073ab",
      "name": "Asset-A",
      "path": "https://storage.account",
      "resolution": 10,
      "updated_at": "2022-11-14 12:55:49.125928+00:00",
      "visualization_id": "e9767554-550e-4464-a677-b8cf096073ab"
    }
  ],
  "created_at": "2022-11-14 12:55:49.125928+00:00",
  "expression": "(B08 - B04) / (B08 + B04)",
  "id": "a80f7f4c-abe9-4118-875e-3a2306577e11",
  "index_id": "90d63531-5f54-4704-a4b0-7bb92ae08f23",
  "index_name": "NDVI-Custom",
  "progress": 100,
  "rescale": [
    0,
    1
  ],
  "tenant_id": "tenant-123456",
  "updated_at": "2022-11-14 12:55:49.125928+00:00",
  "user_id": "e3a671ad-5381-4413-8c1c-bc4e1ccaff45"
}