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-Bangalore",
  "description": "This AOI contains images related to Bangalore",
  "lens_satellite_id": "ce5dcc14-8291-4b0c-a278-8c05ec426d22",
  "provider": "planetary",
  "project_id": "ce5dcc14-8291-4b0c-a278-8c05ec426d18",
  "geometry": {
    "coordinates": [
      [
        [
          123
        ]
      ]
    ],
    "type": "<string>"
  },
  "item_ids": [
    "TD0123233",
    "TD01232344"
  ]
}'
{
  "aoi_id": "e9767554-550e-4464-a677-b8cf096073ab",
  "name": "AOI-Bangalore",
  "description": "This AOI contains images related to Bangalore",
  "lens_satellite_id": "ce5dcc14-8291-4b0c-a278-8c05ec426d22",
  "project_id": "ce5dcc14-8291-4b0c-a278-8c05ec426d18",
  "images": {},
  "eo_bands": [
    "B01",
    "B02",
    "B03"
  ],
  "geometry": {
    "coordinates": [
      [
        [
          123
        ]
      ]
    ],
    "type": "<string>"
  },
  "progress": 100,
  "status": "success",
  "is_favourite": false,
  "created_at": "2022-11-14 12:55:49.125928+00:00",
  "updated_at": "2022-11-14 12:55:49.125928+00:00",
  "user_id": "user-123456",
  "area_in_sq_m": 123456.78,
  "centroid": [
    77.55,
    12.95
  ]
}

Authorizations

​
Authorization
string
header
required

Body

application/json

AOI Creation Request

​
name
string
required

Name of the AOI

Example:

"AOI-Bangalore"

​
description
string
required

Description of the AOI

Example:

"This AOI contains images related to Bangalore"

​
lens_satellite_id
string
required

Lens satellite ID

Example:

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

​
provider
string
required

Data provider

Example:

"planetary"

​
project_id
string
required

Project ID this AOI belongs to

Example:

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

​
geometry
object
required

Geometry of the AOI

​
item_ids
string[]
required

List of item IDs

Example:
["TD0123233", "TD01232344"]

Response

Created

​
aoi_id
string

ID of the AOI

Example:

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

​
name
string

AOI name

Example:

"AOI-Bangalore"

​
description
string

AOI description

Example:

"This AOI contains images related to Bangalore"

​
lens_satellite_id
string

Lens satellite ID

Example:

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

​
project_id
string

Project ID this AOI belongs to

Example:

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

​
images
object

Images associated with the AOI

​
eo_bands
string[]

EO bands

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

Geometry of the AOI

​
progress
integer

Progress of the AOI from 0 to 100 in percentage

Example:

100

​
status
enum<string>

Status of the AOI

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

"success"

​
is_favourite
boolean

Whether the AOI is marked as favourite

Example:

false

​
created_at
string

AOI creation datetime

Example:

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

​
updated_at
string

AOI update datetime

Example:

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

​
user_id
string

User ID who created the AOI

Example:

"user-123456"

​
area_in_sq_m
number

Area in square meters

Example:

123456.78

​
centroid
number[]

Centroid coordinates

Example:
[77.55, 12.95]
⌘I