> ## Documentation Index
> Fetch the complete documentation index at: https://help.gorelo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Gorelo API overview

> Use the Gorelo API to integrate external products, with API key authentication via the X-API-Key header, scoped permissions, and HTTP error handling.

Gorelo allows you to integrate with any external product through the Gorelo API.

The Gorelo API uses API keys. Include your key in every request via the X-API-Key header.

The Gorelo base URL depends on the region you opted to host your data on in Gorelo:

<Tabs>
  <Tab title="US">
    Base URL: [**https://api.usw.gorelo.io/**](https://api.usw.gorelo.io/)\
    API Reference: [**https://api.usw.gorelo.io/swagger**](https://api.usw.gorelo.io/swagger)
  </Tab>

  <Tab title="Australia">
    Base URL: [**https://api.aue.gorelo.io/**](https://api.aue.gorelo.io/)\
    API Reference: [**https://api.aue.gorelo.io/swagger**](https://api.aue.gorelo.io/swagger)
  </Tab>
</Tabs>

## Scopes and permissions

You can **scope** API keys. If a key lacks access to an endpoint, the API returns **403 Forbidden**.

## Error handling

| Error                     | Meaning                       |
| :------------------------ | :---------------------------- |
| **401 Unauthorized**      | Missing/invalid API key       |
| **403 Forbidden**         | Valid key, insufficient scope |
| **429 Too Many Requests** | Rate limit exceeded           |

## Status IDs

## Agent assets

| ID | Status                |
| :- | :-------------------- |
| 1  | Installing            |
| 2  | Online                |
| 3  | Offline               |
| 4  | Pending Delete        |
| 5  | Deleted               |
| 6  | Pending Client Delete |
| 7  | Client Deleted        |