'How to' Library

To access and interact with the Aurora API, you’ll first need to generate a project-specific API key to authenticate API requests. This article walks you through the process from start to finish.

Step 1: Create a Service Account and Generate an API Key

1. Log in to your organization.

2. Make sure you have a project that you have access to. If you do not, create a new project as shown below.
   
   Give Project title and name to complete the project creation
   

3. Navigate to Organization Settings → API.
   

4. Click on Create new service account. A small window will pop up, asking Name and the Project under which the service account should be created. After filling it up, click Create.
   

5. By default, the an initial API key is generated. Make sure to copy and store it securely, as you won’t be able to view it again later.
   

6. You can create multiple keys per service account. If you want to generate another key under the same service account, you can revoke the access to the previous one, and create a new key by giving it a name and  clicking Generate new key at the top.
   
   

7. You can also manage which projects this service account has access to by clicking on Manage access and selecting all the projects you want access for. Note that you can only select the projects you are part of.

IMPORTANT: Keep your API keys secure. Do not share them publicly.

Step 2: Test Your API Key

1. Open the Aurora API Documentation Portal.
   

2. Select an endpoint to test—for example, List all bandsets. Click on Try it to test. out the API Key.
   

3. In the Authentication field, paste your API key. and click Send to send your request
   
   
   

4. If you receive a response with code 200, it means that your request went through and your API key is working just fine. If you receive response code 40x, check your request parameters for some errors.

---

That’s It!

You’ve successfully generated and tested your API key. You’re now ready to build with the Aurora API!

Need help with specific endpoints or error handling? Visit the full API reference for more details.

See more

This guide walks you through the process of switching organizations in your Aurora dashboard.

1. Visit Aurora

 

2. Click the top-left icon to view all organizations linked to your account.

 

3. Select any organization that you would like to work with. 

 

Related to Aurora. 

See more

Pixxel's hyperspectral imaging satellites provide valuable Earth observation data with detailed spectral information. Here's a step-by-step guide on how to explore and access these images through the platform.

Getting Started with Pixxel Constellations

To begin exploring Pixxel's hyperspectral imagery:

1. Navigate to the Explore page on the platform
2. Look for the Pixxel Constellations icon in the tools panel on the right side of the screen

You can select either one or both satellites simultaneously by checking the corresponding boxes in the Pixxel Constellations panel.

1. 

 

Exploring Available Imagery

Once you've selected your preferred satellites:

1. Zoom out to a global view to see all available image locations
2. Red pins on the world map indicate locations where Pixxel imagery is available
3. Each pin represents a specific image capture from one of the Pixxel satellites

1. 

2. Viewing Image Details

   To examine a specific image:

   1. Click on a red pin of interest on the map
   2. The selected area will be displayed with its boundaries outlined.
3. 

Accessing Full Image Data

To request access to the full hyperspectral image:

1. Click the "View more info" button on the image preview panel

• Copy the Image ID from the highlighted field
• Share this ID with your contact person at Pixxel to gain access to the full hyperspectral datase

See more

To view the available subscription plans in Aurora:

1. Click on your email address in the top-left corner of the screen to open the dropdown menu

Select "Organization settings"

2. In the left sidebar menu, click on "Plans"

Alternatively
Click on the upgrade Icon on the left

 

Here you'll find three subscription tiers:

• Standard Plan 
• Professional Plan - Includes Analytics and 150 free tokens
• Enterprise Plan  - Includes Advanced features and 300 free tokens

Each paid plan offers monthly and yearly billing options, with a 10% discount when you choose annual billing.

For more information about billing and invoices, you can contact support@pixxel.space

Note: Both Professional and Enterprise plans include a 30-day free trial period and unlimited wallet recharge options.

See more

1. Visit Aurora

 

2. Enter the email address you want to register/ Use your google account to sign up

 

 

Click Continue with Email

3. Enter the OTP sent to your email ID:

           

Submit OTP to continue

You will enter the explore page of Aurora.

See more

What are tokens:

Tokens are Pixxel's virtual currency used to purchase imagery, perform visualisations, and create workflows on the Aurora platform.

Note: 1$- 1 Token

 

Checking and adding tokens:

Checking Token Balance

1. Navigate to "Tokens" in the organisation menu

Your available tokens are displayed prominently with a pink diamond icon and a numerical value next to it

 

Adding New Tokens

Click the "Add tokens" button in the top right of the Tokens page

Select the desired quantity (starts at $1.00)

Once the payment is completed, the tokens will reflect on the token section.

 

See more

In this guide, you'll learn how to view and manage your billing information and invoices.

 

Accessing Billing Information

1. Navigate to "Organization" in the sidebar

2. Select "Billing" from the menu options

3. View your billing dashboard

4. Click on "View Invoice"

Note: The invoice number is present here. Choose between downloading the invoice or downloading the receipt.

 

Note: For additional support or questions, contact support@pixxel.space

See more

In this guide, you'll learn how to browse and select satellite imagery from available options for your area of interest.

After selecting/uploading your AOI, you will be presented with this screen:

You can select several options based off your need:

Setting Date Range:

1. Look for the Date Range section at the top of the Filters panel
2. Use the calendar icons to select:
   • Start date
   • End date
3. The system will display images within your selected range for your AOI

Access the Satellites section to select from:

• Landsat 8-9
• Sentinel-2
• Modis NBAR Daily
• Pixel-TD01
• Pixel-TD02
• Sentinel-1 (RTC)
• MODIS LST/E 8-Day

• MODIS SR 8-Day 250m

• EO-01 Hyperion\

Cloud Percentage:

• Percentage of cloud cover

Spatial Resolution (GSD):

• Specific to each satellite

The Image information will be on the right side and it will inform the image you have selected

Once you have selected the image you need, click on Save:

You will then see this screen: 

Click Save to save your AOI

Note: You can create a new Project if no previous projects exist.

Great! you have now saved your AOI.

See more

In this guide, you'll learn how to upload Area of Interest (AOI) files to visualize and analyze specific geographic regions in our platform.

 

How to Upload Files

1. Navigate to the "Explore" section

 

2. Click the "Upload AOI" button in the top right corner

 

Note: Supported File Formats The platform accepts the following file formats:

• GeoJSON
• KML
• KMZ
• Zipped SHP files
• Single SHP files

You will receive an error like this if you upload the wrong file:

 

3. Select your file from your local system

 

4. Wait for the file to process and appear on the map

Note: When defining your Area of Interest (AOI), keep in mind the following size restrictions:

• Maximum AOI size is 5000 km²
• Attempting to exceed this limit will trigger an "Area Limit Reached!" warning
• You will need to either:
  • Reduce your selected area to stay within limits
  • Click "Upgrade Plan" for larger area analysis capabilities
• AOI with holes (donuts) are not supported.
• Only WGS84 [EPSG:4326] projection is supported

See more

1. You can export the images to our preferred delivery process

 

2. You can choose your desired delivery method - Local and Cloud storage

 

3. Save your preferred selection for future orders. 

See more

This guide walks you through the process of creating your Aurora account and setting up your organisation.

 

1. Visit Aurora

 

2. Enter the email address you want to register/ Use your google account to sign up

 

 

Click Continue with Email

3. Enter the OTP sent to your email ID:

           

Submit OTP to continue

 

4. Create Organisation

 

5. Enter your basic details and create your workspace

 

On clicking on "Create" you will enter the explore page of Aurora.

See more