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

# Introdução

> Bem-vindo à API First Answer. Acesse seus dados de monitoramento de visibilidade de IA programaticamente.

## Visão Geral

A API First Answer oferece acesso programático aos dados disponíveis na plataforma First Answer. Use-a para integrar insights de visibilidade de IA em seus próprios fluxos de trabalho, dashboards e ferramentas.

Todos os endpoints são **somente leitura** (HTTP `GET`) e retornam dados em formato JSON. A API segue convenções RESTful e utiliza códigos de status HTTP padrão.

## URL Base

Todas as requisições à API devem ser feitas para:

```text theme={null}
https://api.firstanswer.ai
```

## Recursos Disponíveis

| Recurso                                                             | Descrição                                                                    |
| ------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| [Marcas](/pt/api-reference/brands)                                  | Suas marcas monitoradas e seus dados de visibilidade                         |
| [Grupos](/pt/api-reference/groups)                                  | Grupos de prompts para organização                                           |
| [Concorrentes Monitorados](/pt/api-reference/monitored-competitors) | Marcas concorrentes e seus dados de visibilidade                             |
| [Prompts Monitorados](/pt/api-reference/monitored-prompts)          | Prompts de IA sendo rastreados, com respostas, citações e consultas de busca |
| [Fontes Citadas](/pt/api-reference/cited-sources)                   | Domínios e URLs citados em respostas de IA, com prompts relacionados         |
| [Planos de Ação](/pt/api-reference/action-plans)                    | Planos de ação sugeridos para melhorar a visibilidade de IA                  |
| [Dashboard](/pt/api-reference/dashboard)                            | Métricas agregadas do dashboard                                              |

## Formato de Resposta

Todas as respostas bem-sucedidas seguem uma estrutura consistente.

**Recurso único:**

```json theme={null}
{
  "data": {
    "id": 1,
    "name": "Marca Exemplo"
  }
}
```

**Lista paginada:**

```json theme={null}
{
  "pagination": {
    "current_page": 1,
    "per_page": 100,
    "total_pages": 3,
    "total_records": 250
  },
  "data": [
    { "id": 1, "name": "Marca Exemplo" }
  ]
}
```

## Paginação

Endpoints de listagem retornam resultados paginados. Use os parâmetros de consulta `page` e `per_page` para controlar a paginação:

| Parâmetro  | Tipo    | Padrão | Descrição                                         |
| ---------- | ------- | ------ | ------------------------------------------------- |
| `page`     | integer | `1`    | Número da página (começando em 1)                 |
| `per_page` | integer | `100`  | Número de itens por página (mín: `1`, máx: `100`) |

## Formato de Erro

Todos os erros retornam uma estrutura JSON consistente:

```json theme={null}
{
  "error": {
    "code": "ERROR_CODE",
    "message": "Uma descrição legível do erro."
  }
}
```

### Códigos de Erro

| Status HTTP | Código                  | Descrição                                                                                                |
| ----------- | ----------------------- | -------------------------------------------------------------------------------------------------------- |
| `401`       | `AUTHENTICATION_FAILED` | Chave de API ausente, inválida ou expirada                                                               |
| `403`       | `PERMISSION_DENIED`     | A chave de API não tem acesso a este recurso                                                             |
| `404`       | `NOT_FOUND`             | O recurso solicitado não existe                                                                          |
| `405`       | `METHOD_NOT_ALLOWED`    | Método HTTP não suportado para este endpoint                                                             |
| `429`       | `RATE_LIMIT_EXCEEDED`   | Limite de requisições do projeto excedido — veja [Limites de requisições](/pt/api-reference/rate-limits) |
| `500`       | `INTERNAL_SERVER_ERROR` | Ocorreu um erro inesperado no servidor                                                                   |

## Início Rápido

<Steps>
  <Step title="Obtenha sua chave de API">
    Acesse as [configurações da sua conta](https://app.firstanswer.ai/settings/api-keys) e gere uma nova chave de API. Copie-a imediatamente — ela não será exibida novamente.
  </Step>

  <Step title="Faça sua primeira requisição">
    ```bash theme={null}
    curl -H "api-key: SUA_CHAVE_API" \
      https://api.firstanswer.ai/v1/brands/
    ```
  </Step>

  <Step title="Explore os dados">
    Use a resposta para navegar por recursos relacionados como prompts monitorados, citações e concorrentes.
  </Step>
</Steps>

## Precisa de Ajuda?

Se você tiver dúvidas ou encontrar problemas, entre em contato com nossa equipe de suporte em [support@firstanswer.ai](mailto:support@firstanswer.ai).