Introdução - First Answer

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:

https://api.firstanswer.ai

Recursos Disponíveis

Recurso	Descrição
Marcas	Suas marcas monitoradas e seus dados de visibilidade
Grupos	Grupos de prompts para organização
Concorrentes Monitorados	Marcas concorrentes e seus dados de visibilidade
Prompts Monitorados	Prompts de IA sendo rastreados, com respostas, citações e consultas de busca
Fontes Citadas	Domínios e URLs citados em respostas de IA, com prompts relacionados
Planos de Ação	Planos de ação sugeridos para melhorar a visibilidade de IA
Dashboard	Métricas agregadas do dashboard

Formato de Resposta

Todas as respostas bem-sucedidas seguem uma estrutura consistente. Recurso único:

{
  "data": {
    "id": 1,
    "name": "Marca Exemplo"
  }
}

Lista paginada:

{
  "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:

{
  "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
`500`	`INTERNAL_SERVER_ERROR`	Ocorreu um erro inesperado no servidor

Início Rápido

Obtenha sua chave de API

Acesse as configurações da sua conta e gere uma nova chave de API. Copie-a imediatamente — ela não será exibida novamente.

Faça sua primeira requisição

curl -H "api-key: SUA_CHAVE_API" \
  https://api.firstanswer.ai/v1/brands/

Explore os dados

Use a resposta para navegar por recursos relacionados como prompts monitorados, citações e concorrentes.

Precisa de Ajuda?

Se você tiver dúvidas ou encontrar problemas, entre em contato com nossa equipe de suporte em [email protected].

​Visão Geral

​URL Base

​Recursos Disponíveis

​Formato de Resposta

​Paginação

​Formato de Erro

​Códigos de Erro

​Início Rápido

​Precisa de Ajuda?