> ## 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.

# Visão geral da API do Gorelo

> Use a API do Gorelo para integrar produtos externos, com autenticação por chave no cabeçalho X-API-Key, permissões com escopo e tratamento de erros HTTP.

O Gorelo permite que você integre qualquer produto externo por meio da API do Gorelo.

A API do Gorelo usa chaves de API. Inclua sua chave em cada requisição por meio do cabeçalho X-API-Key.

A URL base do Gorelo depende da região que você escolheu para hospedar seus dados no Gorelo:

<Tabs>
  <Tab title="US">
    URL base: [**https://api.usw.gorelo.io/**](https://api.usw.gorelo.io/)\
    Referência da API: [**https://api.usw.gorelo.io/swagger**](https://api.usw.gorelo.io/swagger)
  </Tab>

  <Tab title="Australia">
    URL base: [**https://api.aue.gorelo.io/**](https://api.aue.gorelo.io/)\
    Referência da API: [**https://api.aue.gorelo.io/swagger**](https://api.aue.gorelo.io/swagger)
  </Tab>
</Tabs>

## Escopos e permissões

As chaves de API podem ter **escopo definido**. Se uma chave não tiver acesso a um endpoint, a API retorna **403 Forbidden**.

## Tratamento de erros

| Erro                      | Significado                       |
| :------------------------ | :-------------------------------- |
| **401 Unauthorized**      | Chave de API ausente/inválida     |
| **403 Forbidden**         | Chave válida, escopo insuficiente |
| **429 Too Many Requests** | Limite de requisições excedido    |

## IDs de status

## Ativos do agente

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