Documentação · Quickstart

Do zero ao primeiro scan

Cinco passos: conta, onboarding, API key, primeiro request e verificação da evidência. Cada passo descreve o que existe hoje — quando algo ainda é roadmap, está escrito no passo, não escondido.

1. Crie a conta

O cadastro é em app.genopt.ai/signup. E-mail e senha bastam para começar; o plano define quais engines entram nos seus scans e quantos scans por mês o teto permite — a conta de custo por engine está aberta em /precos.

2. Passe pelo onboarding

Ao entrar pela primeira vez, o wizard de onboarding monta o mínimo para um scan fazer sentido, nesta ordem: a organização (onde marcas, perguntas e medições ficam guardadas), a marca (o domínio sobre o qual as IAs serão perguntadas — lemos título e descrição do site para adiantar o preenchimento), as perguntas (lemos seu site e sugerimos prompts que um cliente real faria a uma IA sobre o setor; você seleciona os que quer monitorar) e os concorrentes (share of voice só faz sentido contra alguém — sugerimos quem disputa as mesmas respostas a partir dos seus prompts).

3. Gere uma API key

Em Settings → API Keys (papel Owner ou Admin), o app emite chaves no formato gsk_<32 hex>. A chave em claro aparece uma única vez, na criação; do nosso lado ficam apenas o SHA-256 e o prefixo de exibição. Estado atual, sem rodeios: essas keys ainda não autenticam a API pública — a emissão é antecipada para a integração com os SDKs, e a autenticação por key de cliente é a Fase 8 do roadmap. Hoje a API aceita o token interno da plataforma, de uso server-side; os dois endpoints públicos de verificação (passo 5) não pedem token nenhum.

4. Primeiro request na API v1

Com um token válido no header Authorization: Bearer, o fluxo mínimo é disparar um scan e acompanhar o status. O scan roda assíncrono no worker: a resposta imediata é um 202 com o scanId.

scan
# Dispara um scan da marca (resposta: 202 Accepted + scanId)
curl -X POST https://api.genopt.ai/v1/scans \
  -H 'Authorization: Bearer <SEU_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"brandId":"<brandId>"}'

# Acompanha o status: contadores de runs, menções, custo
curl -s https://api.genopt.ai/v1/scans/<scanId> \
  -H 'Authorization: Bearer <SEU_TOKEN>'

Terminado o scan, a pergunta que importa: o que as IAs inventaram sobre a marca? A matriz de classes de citação e a lista das execuções CONFABULATED saem do mesmo endpoint:

confabulações
curl -s 'https://api.genopt.ai/v1/brands/<brandId>/confabulations?window=7d' \
  -H 'Authorization: Bearer <SEU_TOKEN>'

A referência completa — todos os endpoints, erros e o spec OpenAPI 3.1 — está em /docs/api. Quem prefere não falar HTTP na mão usa os SDKs TypeScript e Python ou o servidor MCP.

5. Verifique a evidência

Toda resposta de IA capturada pelo GenOpt é armazenada bruta com um hash SHA-256 — e a verificação é deliberadamente pública: um hash que só o emissor consegue conferir não prova nada. Na interface, cole o hash em genopt.ai/verify; por código, use os dois endpoints públicos:

verificação pública
# O hash existe? Não requer autenticação nem conta.
curl -s https://api.genopt.ai/v1/public/evidence/<hash-sha256>

# Tem o conteúdo em mãos? Confira byte a byte (verified | modified):
curl -X POST https://api.genopt.ai/v1/public/evidence/<hash-sha256>/check \
  -H 'Content-Type: application/json' \
  -d '{"content":"<texto exato da resposta>"}'

Se você chegou aqui a partir de um relatório de terceiro — uma agência, um fornecedor — e só quer saber se os dados são reais, o passo 5 é o único de que você precisa: ele não exige conta.