Skip to main content
POST
/
v0
/
aois
Create a new AOI
curl --request POST \
  --url https://api.pixxel.space/v0/aois \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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",
    "coordinates": [
      [
        [
          123
        ]
      ]
    ]
  },
  "item_ids": [
    "TD2_00056_20230815_L2A_004010_01001001"
  ]
}
'
{
  "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",
  "images": {},
  "eo_bands": [
    "B01",
    "B02",
    "B03"
  ],
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          123
        ]
      ]
    ]
  },
  "progress": 100,
  "status": "success",
  "is_favourite": false,
  "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
  ]
}
📚 View developer guide to learn more

Authorizations

​
Authorization
string
header
required

Body

application/json

AOI Creation Request

​
name
string
required

Unique user friendly name of the AOI for easier identification

Example:

"AOI-D2"

​
description
string
required

Brief description of the AOI explaining its purpose or contents

Example:

"This AOI contains images of D2"

​
satellite_id
string
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

Example:

"0005c5bb-0bd2-4c80-9393-4a808341c54c"

​
provider
string
required

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

Example:

"pixxel"

​
project_id
string
required

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

Example:

"ce5dcc14-8291-4b0c-a278-8c05ec426d22"

​
geometry
object
required

Polygon geometry defining the geographic boundary of the AOI

​
item_ids
string[]
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:
["TD2_00056_20230815_L2A_004010_01001001"]

Response

Created

​
aoi_id
string

Unique identifier (UUID) of the created AOI

Example:

"e9767554-550e-4464-a677-b8cf096073ab"

​
name
string

Unique user friendly name of the AOI for easier identification

Example:

"AOI-D2"

​
description
string

Brief description of the AOI explaining its purpose or contents

Example:

"This AOI contains images of D2"

​
satellite_id
string

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

Example:

"0005c5bb-0bd2-4c80-9393-4a808341c54c"

​
project_id
string

UUID of the project this AOI belongs to

Example:

"ce5dcc14-8291-4b0c-a278-8c05ec426d22"

​
images
object

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

​
eo_bands
string[]

List of Earth Observation bands available for this AOI

Example:
["B01", "B02", "B03"]
​
geometry
object

GeoJSON Polygon geometry defining the geographic boundary of the AOI

​
progress
integer

Processing progress of the AOI from 0 to 100 in percentage

Example:

100

​
status
enum<string>

Current status of the AOI: success, started, running, failed, updating, partial_success

Available options:
success,
started,
running,
failed,
updating,
partial_success
Example:

"success"

​
is_favourite
boolean

Whether the AOI is marked as favourite by the user

Example:

false

​
created_at
string

Timestamp when the AOI was created (ISO 8601 format)

Example:

"2022-11-14T12:55:49.125928+00:00"

​
updated_at
string

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

Example:

"2022-11-14T12:55:49.125928+00:00"

​
user_id
string

Unique identifier of the user who created the AOI

Example:

"user-123456"

​
area_in_sq_m
number

Total area of the AOI in square meters

Example:

123456.78

​
centroid
number[]

Geographic centroid coordinates of the AOI [longitude, latitude]

Example:
[77.55, 12.95]