Docs da Nyqo API

Passo a passo

Quickstart

1. 1

   Crie sua conta e gere uma chave

   Cadastre-se e gere uma chave nyq_… no painel. Cada chave tem escopo por endpoint e pode ser revogada quando quiser.

   Criar conta grátis
2. 2

   Faça sua primeira chamada

   Busca na web — um GET simples, sem body:

   curl "https://api.nyqo.dev/api/v1/search/web?q=exemplo%20de%20busca&max=5" \n  -H "Authorization: Bearer nyq_sua_chave_aqui"

3. 3

   Trate erros e limites

   Respostas de erro seguem um envelope único (success/error.code/error.message). Recebeu 429? Aguarde os segundos do header Retry-After antes de repetir.

Chaves nyq_

Autenticação

Toda chamada ao data-plane exige sua chave em um header — nunca na query string (?api_key vaza em logs de proxy/CDN e é ignorado). Chaves antigas msk_ são inválidas na Nyqo.

curl "https://api.nyqo.dev/api/v1/search/web?q=nyqo&max=3" \
  -H "Authorization: Bearer nyq_sua_chave_aqui"

curl "https://api.nyqo.dev/api/v1/search/web?q=nyqo&max=3" \
  -H "X-API-Key: nyq_sua_chave_aqui"

• · Sem chave → 401 com header WWW-Authenticate.
• · Chave fora do escopo ou plano sem a rota → 403.
• · Gerencie escopos (allowed_endpoints), rotação e revogação no painel.

Quotas

Rate limits

HTTP/1.1 429 Too Many Requests
Retry-After: 60
Content-Type: application/json

{
  "success": false,
  "error": {
    "code": "rate_limited",
    "message": "Limite de requisições excedido"
  }
}

Envelope único

Códigos de erro

Todo erro volta no mesmo shape — {"success": false, "error": {"code", "message"}} — com mensagens em pt-BR, sem detalhe interno:

{
  "success": false,
  "error": {
    "code": "unauthorized",
    "message": "API key ausente. Use Authorization: Bearer SUA_API_KEY ou o header X-API-Key"
  }
}

Referência

Endpoints por categoria