Sign in

v1

latestOpenAPI 3.0.02026-08-0455133277.1 KB
AOI

Create a new AOI

Creates a new AOI with specified parameters

post/v0/aois

Request body

namestring required

Unique user friendly name of the AOI for easier identification

descriptionstring required

Brief description of the AOI explaining its purpose or contents

satellite_idstring required

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

providerstring required

Data provider source for satellite imagery: - pixxel - For TD and Firefly satellite imagery - planetary - For all open source satellite data (Landsat, Sentinel, etc.)

project_idstring required

UUID of the project this AOI belongs to. The AOI will be associated with this project for organization

item_idsstring[] required

Array of satellite image item IDs to include in this AOI. Item IDs Example: ["TD2_000650_20230404_L2A_20240405_01001067", "TD1_005630_20230314_L2A_20230504_03001069"]

Example request

{
  "name": "AOI-D2",
  "description": "This AOI contains images of D2",
  "satellite_id": "0005c5bb-0bd2-4c80-9393-4a808341c54c",
  "provider": "pixxel",
  "project_id": "ce5dcc14-8291-4b0c-a278-8c05ec426d22",
  "geometry": {
    "type": "Polygon"
  },
  "item_ids": [
    "TD2_00056_20230815_L2A_004010_01001001"
  ]
}

Response

Created

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

status'success' | 'started' | 'running' | 'failed' | 'updating' | 'partial_success'
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
  ]
}