v1

latestOpenAPI 3.0.02026-08-0455133277.1 KB

AOI

Get AOI

Get AOI by ID. Only the AOIs under current service user will be accessible.

get/v0/aoi/{aoi_id}

Path parameters

aoi_idstring required

AOI ID

Response

aoi_idstring

Unique identifier (UUID) of the created AOI

namestring

Unique user friendly name of the AOI for easier identification

descriptionstring

Brief description of the AOI explaining its purpose or contents

satellite_idstring

Unique identifier (UUID) for the satellite. Each satellite has a unique ID mapped to its name: - Pixxel-TD1 - 0004ab8d-0ad1-4d62-8a3f-fe18a7000e70 - Pixxel-TD2 - 0005c5bb-0bd2-4c80-9393-4a808341c54c

project_idstring

UUID of the project this AOI belongs to

imagesobject

Map of images associated with the AOI, keyed by image identifier

eo_bandsstring[]

List of Earth Observation bands available for this AOI

progressinteger

Processing progress of the AOI from 0 to 100 in percentage

is_favouriteboolean

Whether the AOI is marked as favourite by the user

created_atstring

Timestamp when the AOI was created (ISO 8601 format)

updated_atstring

Timestamp when the AOI was last updated (ISO 8601 format)

user_idstring

Unique identifier of the user who created the AOI

area_in_sq_mnumber

Total area of the AOI in square meters

centroidnumber[]

Geographic centroid coordinates of the AOI [longitude, latitude]

Example response

{
  "aoi_id": "e9767554-550e-4464-a677-b8cf096073ab",
  "name": "AOI-D2",
  "description": "This AOI contains images of D2",
  "satellite_id": "0005c5bb-0bd2-4c80-9393-4a808341c54c",
  "project_id": "ce5dcc14-8291-4b0c-a278-8c05ec426d22",
  "eo_bands": [
    "B01",
    "B02",
    "B03"
  ],
  "geometry": {
    "type": "Polygon"
  },
  "progress": 100,
  "created_at": "2022-11-14T12:55:49.125928+00:00",
  "updated_at": "2022-11-14T12:55:49.125928+00:00",
  "user_id": "user-123456",
  "area_in_sq_m": 123456.78,
  "centroid": [
    77.55,
    12.95
  ]
}