REST API

Referência da API

Acesso HTTP direto a todos os recursos do Baseline Labs. Autentique-se com sua chave de API e chame de qualquer idioma.

URL Base

https://baselinelabs.ai/api/

Autentique-se com o cabeçalho X-API-Key: bl_your_key em cada solicitação.

Projetos

GET /api/geo/saves

Liste todos os seus projetos.

{
  "saves": [
    { "id": 42, "name": "My Brand", "url": "https://mybrand.com" }
  ]
}

POST /api/geo/saves

Crie um novo projeto.

{ "name": "My Brand", "url": "https://mybrand.com" }

Pesquisa

POST /api/geo/search

Execute uma pesquisa em Google, GPT, Perplexity, Gemini, Google AI Mode, Claude e DeepSeek. Custa créditos.

{
  "save_id": 42,
  "queries": ["best project management tools", "top PM software 2026"]
}

Retorna um ID de pesquisa. Consulte os resultados:

GET /api/geo/search/{search_id}

Obtenha os resultados da pesquisa assim que o processamento for concluído.

Relatórios de Visibilidade

GET /api/geo/reports/templates

Liste seus modelos de relatório.

POST /api/geo/reports/run

Execute um relatório de visibilidade a partir de um modelo. Custa créditos.

{ "template_id": 12 }

GET /api/geo/reports/{report_id}

Obtenha os resultados do relatório, incluindo classificações por consulta.

Menções de Marca

POST /api/geo/mentions/scan

Crie uma varredura de menções de marca. Custa créditos.

{ "save_id": 42, "brand_name": "My Brand" }

GET /api/geo/mentions/{scan_id}

Obtenha os resultados da varredura e registros de menções individuais.

Schema.org

POST /api/geo/schema/generate

Gere schema.org JSON-LD para qualquer URL usando inferência de GPU.

{ "url": "https://example.com/page" }

Resposta:

{
  "url": "https://example.com/page",
  "schema_url": "https://schema.baselinelabs.ai/abc123.json",
  "cached": true,
  "inference_ms": 12
}

GET /api/geo/schema/status/{job_id}

Verifique o status do trabalho assíncrono de geração de schema (para trabalhos >5s).

Respostas de Erro

Todos os erros retornam JSON com um campo detail.

401 Chave de API inválida ou ausente

402 Créditos insuficientes

429 Limite de taxa excedido

404 Recurso não encontrado