## Overview
<p align="justify">
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

</p>
---

## Authorization
<p align="justify">
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

```json
Authorization: <YOUR_API_KEY>
```
</p>

---

## Query Parameters
<p align="justify">
You dont really need to put query parameters for `Get AOI`.
</p>

---

## Path Parameters
<p align="justify">
The only **path parameter** required is the `aoi_id` parameter which is a **string**.

| Name    | Type   | Required | Description                  |
|---------|--------|----------|------------------------------|
| `aoi_id`  | `string` | Yes      | Unique identifier of the AOI |

</p>

---

## Response

<p align="justify">
### 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:

| Name             | Type      | Description                                                                      |
|------------------|-----------|----------------------------------------------------------------------------------|
| `aoi_id`           | `string`    | ID of the AOI                                                                    |
| `name`             | `string`    | Human-readable name of the AOI                                                  |
| `description`      | `string`    | Description of the AOI                                                          |
| `satellite_id`     | `string`    | Lens satellite ID associated with the AOI                                       |
| `project_id`       | `string`    | ID of the project this AOI belongs to                                           |
| `images`           | `object`    | Images associated with the AOI                                                  |
| `eo_bands`         | `string[]`  | EO bands used in the AOI (e.g., ["B01", "B02", "B03"])                          |
| `geometry`         | `object`    | GeoJSON geometry of the AOI                                                     |
| `progress`         | `integer`   | Progress of the AOI (0 to 100)                                                  |
| `status`           | `string`    | Status of the AOI (`success`, `started`, `running`, `failed`, etc.)            |
| `is_favourite`     | `boolean`   | Whether the AOI is marked as a favourite                                        |
| `created_at`       | `string`    | Creation timestamp of the AOI (ISO 8601 format)                                 |
| `updated_at`       | `string`    | Last updated timestamp of the AOI (ISO 8601 format)                             |
| `user_id`          | `string`    | ID of the user who created the AOI                                              |
| `area_in_sq_m`     | `number`    | Total area of the AOI in square meters                                          |
| `centroid`         | `number[]`  | 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:


``` json 200
{
  "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
  ]
}
```

- 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: 
``` json 400 403 404 500
{
  "error": {
    "code": "<string>",
    "details": "<any>",
    "message": "<string>"
  }
}
```
</p>

## How to use the endpoint
<p align="justify">
1. Make a **GET** request to `https://api.pixxel.space/v0/aoi/{aoi_id}` to retrieve detailed information about a specific AOI.

1. 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.
</p>