List all AOIs

GET

aois

List all AOIs

curl --request GET \
  --url https://api.pixxel.space/v0/aois \
  --header 'Authorization: <api-key>'

{
  "aois": [
    {
      "aoi_id": "e9767554-550e-4464-a677-b8cf096073ab",
      "name": "AOI-Bangalore",
      "description": "This AOI contains images related to Bangalore",
      "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
      ]
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

📚 View developer guide to learn more

Authorizations

Authorization

string

header

required

Query Parameters

offset

integer

default:0

Offset for pagination

limit

integer

default:10

Limit for pagination

created_at

string

Filter by creation date

updated_at

string

Filter by update date

aoi_id

string

Filter by AOI ID

aoi_name

string

Filter by AOI name

project_ids

string

Filter by project IDs (comma separated)

Response

aois

object[]

Show child attributes

aois.aoi_id

string

ID of the AOI

Example:

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

aois.name

string

AOI name

Example:

"AOI-Bangalore"

aois.description

string

AOI description

Example:

"This AOI contains images related to Bangalore"

aois.satellite_id

string

Satellite ID

Example:

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

aois.project_id

string

Project ID this AOI belongs to

Example:

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

aois.images

object

Images associated with the AOI

aois.eo_bands

string[]

EO bands

Example:

["B01", "B02", "B03"]

aois.geometry

object

Geometry of the AOI

Show child attributes

aois.geometry.coordinates

number[][][]

aois.geometry.type

string

aois.progress

integer

Progress of the AOI from 0 to 100 in percentage

Example:

100

aois.status

enum<string>

Status of the AOI

Available options:

success,

started,

running,

failed,

updating,

partial_success

Example:

"success"

aois.is_favourite

boolean

Whether the AOI is marked as favourite

Example:

false

aois.created_at

string

AOI creation datetime

Example:

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

aois.updated_at

string

AOI update datetime

Example:

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

aois.user_id

string

User ID who created the AOI

Example:

"user-123456"

aois.area_in_sq_m

number

Area in square meters

Example:

123456.78

aois.centroid

number[]

Centroid coordinates

Example:

[77.55, 12.95]

pagination

object

Show child attributes

pagination.total

integer

Example:

100

pagination.offset

integer

Example:

0

pagination.limit

integer

Example:

10

Create a new AOICreates a new AOI with specified parameters

⌘I

List all AOIs

curl --request GET \
  --url https://api.pixxel.space/v0/aois \
  --header 'Authorization: <api-key>'

{
  "aois": [
    {
      "aoi_id": "e9767554-550e-4464-a677-b8cf096073ab",
      "name": "AOI-Bangalore",
      "description": "This AOI contains images related to Bangalore",
      "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
      ]
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

external

Project

AOI

Search

Indices

Visualizations

Blocks

Insights

Assets

Downloads

Workflows

Jobs

Tasks

Bandset

Order

Archives

Report

Stores

Catalog

Authorizations

Query Parameters

Response