API

Execute análises via API REST com a sua própria chave.

Autenticação

Crie uma chave na sua A sua conta e envie-a no cabeçalho X-API-Key em cada pedido. Cada análise consome 1 crédito do seu saldo ou do saldo da sua equipa.

Iniciar uma análise

POST https://serptune.com/api/v1/analyze
X-API-Key: stk_xxxxxxxx.xxxxxxxx
Content-Type: application/json

{
  "url": "https://example.com/your-page",
  "query": "best running shoes",
  "country": "US",
  "language": "en",
  "report_locale": "pt"
}

Resposta: { "uuid": "…", "status": "queued", "result_url": "https://serptune.com/api/v1/analysis?id=…" }

Obter o resultado

GET https://serptune.com/api/v1/analysis?id=<uuid>
X-API-Key: stk_xxxxxxxx.xxxxxxxx

Consulte a cada poucos segundos até status ser completed. O campo report contém então o JSON completo: síntese executiva, ações priorizadas e as secções lacuna semântica, lacuna de UX e preparação para IA.

Erros

401 — chave API inválida ou revogada
402 — créditos insuficientes
422 — dados inválidos (url, query, country, language)
429 — demasiados pedidos, tente mais tarde

Criar chave API