List all AOIs

List all Areas of Interest (AOIs) with optional filtering

GET/v0/aois

Authorisations

AuthorizationString

Query Parameters

offsetinteger

Offset for pagination

limitinteger

Limit for pagination

created_atstring

Filter by creation date

updated_atstring

Filter by update date

aoi_idstring

Filter by AOI ID

aoi_namestring

Filter by AOI name

project_idsstring

Filter by project IDs (comma separated)

Response

application/json

aoisobject[]

Show child attributes

paginationobject

Show child attributes

List all AOIs

1curl -X GET 'https://api.pixxel.space/v0/aois' \
2  -H 'Authorization: YOUR_API_KEY'

Response:

{
  "aois": [
    {
      "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": null,
      "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
      ]
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 100
  }
}

List all AOIs

List all Areas of Interest (AOIs) with optional filtering

GET/v0/aois

Authorisations

AuthorizationString

Query Parameters

offsetinteger

Offset for pagination

limitinteger

Limit for pagination

created_atstring

Filter by creation date

updated_atstring

Filter by update date

aoi_idstring

Filter by AOI ID

aoi_namestring

Filter by AOI name

project_idsstring

Filter by project IDs (comma separated)

Response

application/json

aoisobject[]

Show child attributes

paginationobject

Show child attributes

List all AOIs

1curl -X GET 'https://api.pixxel.space/v0/aois' \
2  -H 'Authorization: YOUR_API_KEY'

Response:

{
  "aois": [
    {
      "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": null,
      "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
      ]
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 100
  }
}