​
Overview

The Get AOI endpoint lets you retrieve information about a specific Area of Interest using its aoi_id. It requires an API key for authentication and returns details like geometry, EO bands, project ID, and metadata. This endpoint supports only AOIs associated with the authenticated user.

  • Method: GET
  • URL: /v0/aoi/{aoi_id}
  • Operation: Retrieve info about a specific AOI
  • Authentication Required: Yes

​
Authorization

You need the api key which you can get from the API tab in Organization Settings. The api key is required in almost all the commands

Authorization: <YOUR_API_KEY>

​
Query Parameters

You dont really need to put query parameters for Get AOI.

​
Path Parameters

The only path parameter required is the aoi_id parameter which is a string.

NameTypeRequiredDescription
aoi_idstringYesUnique identifier of the AOI

​
Response

​
Successful Response – 200 OK

If the request is valid and the AOI exists under the authenticated user, the API returns a 200 OK response with the following fields:
NameTypeDescription
aoi_idstringID of the AOI
namestringHuman-readable name of the AOI
descriptionstringDescription of the AOI
lens_satellite_idstringLens satellite ID associated with the AOI
project_idstringID of the project this AOI belongs to
imagesobjectImages associated with the AOI
eo_bandsstring[]EO bands used in the AOI (e.g., [“B01”, “B02”, “B03”])
geometryobjectGeoJSON geometry of the AOI
progressintegerProgress of the AOI (0 to 100)
statusstringStatus of the AOI (success, started, running, failed, etc.)
is_favouritebooleanWhether the AOI is marked as a favourite
created_atstringCreation timestamp of the AOI (ISO 8601 format)
updated_atstringLast updated timestamp of the AOI (ISO 8601 format)
user_idstringID of the user who created the AOI
area_in_sq_mnumberTotal area of the AOI in square meters
centroidnumber[]Coordinates of the centroid in [longitude, latitude] format
Below is the complete JSON response for searching AOIs using the Get AOI endpoint. Customize the values as needed for your search criteria:
200
{
  "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
  ]
}
  • If you recieve a Bad Request error (400), Forbidden error (403), Not Found error (404) or the Internal Server Error (500), you will get the following response:
400 403 404 500
{
  "error": {
    "code": "<string>",
    "details": "<any>",
    "message": "<string>"
  }
}

​
How to use the endpoint

  1. Make a GET request to https://api.pixxel.space/v0/aoi/{aoi_id} to retrieve detailed information about a specific AOI.
  2. Include the Authorization token in the request headers to authenticate.
  3. Provide the aoi_id as a path parameter to specify which AOI to fetch.