---
title: "Get AOI"
method: GET
path: "/v0/aoi/{aoi_id}"
tags: ["AOI"]
---

# Get AOI

`GET /v0/aoi/{aoi_id}`

## Request

- Base URL: `https://api.pixxel.space`
- URL: `https://api.pixxel.space/v0/aoi/{aoi_id}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/pixxel/apis/stargate/docs/v0/aoi/:aoi_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Get AOI by ID. Only the AOIs under current service user will be accessible.

## Path parameters

- `aoi_id` string, required

## Response `200`

OK

- AtlasAOI
  - `aoi_id` string: Unique identifier (UUID) of the created AOI
  - `name` string: Unique user friendly name of the AOI for easier identification
  - `description` string: Brief description of the AOI explaining its purpose or contents
  - `satellite_id` string: Unique identifier (UUID) for the satellite. Each satellite has a unique ID mapped to its name: - `Pixxel-TD1` - `0004ab8d-0ad1-4d62-8a3f-fe18a7000e70` - `Pixxel-TD2` - `0005c5bb-0bd2-4c80-9393-4a808341c54c`
  - `project_id` string: UUID of the project this AOI belongs to
  - `images` object: Map of images associated with the AOI, keyed by image identifier
  - `eo_bands` string[]: List of Earth Observation bands available for this AOI
  - `geometry` AtlasPolygon
    - `type` string, required: GeoJSON geometry type. Must be "Polygon" for AOI boundaries
    - `coordinates` array[], required: Nested array of coordinates [[[lng,lat],...]] forming a closed polygon. Example: [[[49.32, 40.85], [49.32, 9.08], [110.7, 9.08], [110.7, 40.85], [49.32, 40.85]]]
      - array[]
        - number[]
  - `progress` integer: Processing progress of the AOI from 0 to 100 in percentage
  - `status` 'success' | 'started' | 'running' | 'failed' | 'updating' | 'partial_success'
  - `is_favourite` boolean: Whether the AOI is marked as favourite by the user
  - `created_at` string: Timestamp when the AOI was created (ISO 8601 format)
  - `updated_at` string: Timestamp when the AOI was last updated (ISO 8601 format)
  - `user_id` string: Unique identifier of the user who created the AOI
  - `area_in_sq_m` number: Total area of the AOI in square meters
  - `centroid` number[]: Geographic centroid coordinates of the AOI [longitude, latitude]

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/pixxel/apis/stargate.md) - [All operations](https://skmtc.dev/pixxel/apis/stargate/llms.txt) - [OpenAPI document](https://skmtc.dev/pixxel/apis/stargate/revisions/519562bd9d7a?raw)