Skip to main content

​
Overview

The List Assets for an AOI endpoint retrieves all assets associated with the specified AOI. Results are paginated using offset and limit values. A successful request returns a list of assets along with pagination metadata. Authentication via API key is mandatory, and errors like 404 or 500 return standard error messages with relevant codes and details.

  • Method: GET
  • URL: /v0/aois/{aoi_id}/assets
  • Operation: Retrieve a list of assets for an AOI
  • Authentication Required: Yes

​
Authorization

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

Authorization: <YOUR_API_KEY>

​
Path Parameters

The aoi_id identifies the exact AOI whose assets are to be retrieved.

FieldTypeRequiredDescription
aoi_idstringYesUnique identifier of the AOI

​
Response

​
Successful Response – 200 OK

A 200 OK response from the List Assets for an AOI endpoint indicates that the request was successful. It returns a list of assets created for an AOI, along with pagination metadata. Each asset includes details like name, geometry, EO bands, status, and timestamps.Refer to the table below for the detailed breakdown of each field in the API response:AOI Object Fields
FieldTypeDescription
aoi_idstringUnique identifier for the AOI.
area_in_sq_mfloatArea of the AOI in square meters.
band_listarrayList of EO bands associated with the asset (e.g., ["B01", "B02"]).
created_atstringTimestamp when the Asset was created.
geometry.coordinatesarrayCoordinate arrays defining the AOI geometry.
geometry.typestringType of geometry (e.g., "Polygon" or "MultiPolygon").
idstringUnique identifier for the Asset.
namestringSysytem generated name of the asset.
progressintegerProcessing progress percentage (0–100).
statusstringCurrent status of the Asset (e.g., "success").
updated_atstringTimestamp of the last update to the Asset.
visualization_idstringUnique identifier for the visualization.
Pagination Object Fields
FieldTypeDescription
totalintegerTotal number of assets available for the AOI.
offsetintegerStarting index of the current result page.
limitintegerMaximum number of assets returned in the response.
Below is the complete JSON request for listing assets for an AOI using the List Assets for an AOI endpoint. Customize the values as needed for your search criteria:
200
{
  "assets": [
    {
      "aoi_id": "<string>",
      "area_in_sq_m": 0,
      "asset_type": "mosaic",
      "band_list": [
        "<string>",
        "<string>"
      ],
      "centroid": [
        77.55,
        12.95
      ],
      "created_at": "<string>",
      "date": "<string>",
      "description": "<string>",
      "geometry": {
        "coordinates": [
          [
            [
              123
            ]
          ]
        ],
        "type": "<string>"
      },
      "id": "<string>",
      "name": "<string>",
      "path": "https://storage.account",
      "progress": 0,
      "status": "success",
      "updated_at": "<string>",
      "visualization_id": "<string>"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}
  • If you recieve a Not Found error (404) or the Internal Server Error (500), you will get the following response:
404 500
{
  "error": {
    "code": "<string>",
    "details": "<any>",
    "message": "<string>"
  }
}

​
How to use endpoint

  1. Construct your Request:
    Add your API key to the Authorization header. You can optionally include query parameters like offset, limit, to filter the Assets returned.
  2. Send the Request:
    Send the request to: https://api.pixxel.space/v0/aois/{aoi_id}/assets. Include any query parameters directly in the URL to paginate or filter results.
  3. Examine the Response:
    A successful response (200 OK) returns a list of Assets created for an AOI, along with pagination metadata. In case of failure (404, 500), structured error messages with code, message, and details will be returned.