Pular para o conteúdo principal

​
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

RecursoDescrição
MarcasSuas marcas monitoradas e seus dados de visibilidade
GruposGrupos de prompts para organização
Concorrentes MonitoradosMarcas concorrentes e seus dados de visibilidade
Prompts MonitoradosPrompts de IA sendo rastreados, com respostas, citações e consultas de busca
Fontes CitadasDomínios e URLs citados em respostas de IA, com prompts relacionados
Planos de AçãoPlanos de ação sugeridos para melhorar a visibilidade de IA
DashboardMé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âmetroTipoPadrãoDescrição
pageinteger1Número da página (começando em 1)
per_pageinteger100Nú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 HTTPCódigoDescrição
401AUTHENTICATION_FAILEDChave de API ausente, inválida ou expirada
403PERMISSION_DENIEDA chave de API não tem acesso a este recurso
404NOT_FOUNDO recurso solicitado não existe
405METHOD_NOT_ALLOWEDMétodo HTTP não suportado para este endpoint
429RATE_LIMIT_EXCEEDEDLimite de requisições do projeto excedido — veja Limites de requisições
500INTERNAL_SERVER_ERROROcorreu um erro inesperado no servidor

​
Início Rápido

1

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

Faça sua primeira requisição

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

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