Documentação da API

Aceda aos seus dados de visibilidade de IA através da API REST, da CLI Rust nativa, dos SDKs oficiais para 12 linguagens ou do MCP. Crie dashboards, pipelines ETL e fluxos de trabalho automatizados.

Começar gratuitamente Descarregar especificação OpenAPI

LLM Pulse API

Crie painéis, pipelines de ETL e automatizações com uma API limpa e bem tipada.

LLM Pulse é uma plataforma de análise da visibilidade em IA que monitoriza a forma como a sua marca aparece nas respostas de IA do ChatGPT, do Perplexity, do Gemini e de outros LLMs. A API permite aceder programaticamente a todos os seus dados de visibilidade, incluindo menções à marca, fontes de citação, análise de sentimento e métricas de Share of Voice. Utilize a API para criar painéis personalizados, automatizar relatórios ou integrar o acompanhamento da visibilidade em IA nas ferramentas que já utiliza.

Autenticação

Use um token Bearer da sua chave de API.

Authorization: Bearer YOUR_API_KEY

URL base

Use este URL base para todos os endpoints abaixo. Os exemplos já incluem o caminho completo.

https://api.llmpulse.ai/api/v1

Using an AI agent? Read the llms.txt

We serve a machine-readable version of these docs so coding agents (Claude Code, Cursor, ChatGPT, etc.) can find the right endpoint without parsing this page.

/api-docs/llms.txt : short index, generated from the live route table.

/api-docs/llms-full.txt : full reference (every endpoint, every parameter).

Paridade de 100% entre a interface e a API: encontrou uma lacuna? Fechamo-la

Procuramos uma paridade de 100% entre a interface e a API: tudo o que vê no painel do LLM Pulse deve estar acessível através da API. Se encontrar uma lacuna, comunique-a e comprometemo-nos a implementá-la, normalmente em horas ou poucos dias.

Autenticação

Envie a sua chave no cabeçalho Authorization como um Bearer token. Rode ou revogue em Definições → Chaves de API.

Cabeçalhos ausentes ou malformados devolvem 401 ERR_MISSING_AUTH. Chaves desconhecidas devolvem 401 ERR_INVALID_API_KEY. Chaves revogadas devolvem 403 ERR_REVOKED_API_KEY.

Cada chamada é executada no contexto do utilizador da chave de API. Os projetos têm de pertencer a esse utilizador; caso contrário, 404 ERR_PROJECT_NOT_FOUND.

Estes endpoints aceitam POST/PATCH/PUT/DELETE e requerem uma chave de API com o âmbito read_write. Um token com o âmbito read recebe 403 ERR_INSUFFICIENT_SCOPE. As escritas partilham um limite de taxa mais restrito (60/min/chave), além do orçamento global de 300/min/chave.

Início rápido

O fluxo lógico é: listar recursos → (opcionalmente) obter dimensões → consultar métricas. A primeira chamada a /dimensions/projects já valida a sua chave de API.

Liste os seus projetos: GET /dimensions/projects
(Opcional) Obtenha as dimensões do projeto (concorrentes, modelos, idiomas, etiquetas)
Peça métricas em /metrics/*

Verificação do estado

GET/ping

A forma mais económica de verificar se uma chave funciona e de medir a latência de ida e volta. Devolve ok, o user_id do utilizador autenticado e um request_id. Indique project_id para confirmar também que a chave consegue aceder a esse projeto: nesse caso, a resposta acrescenta project, com o respetivo id, name e brand_name.

Parâmetros:

project_idopcional

Conta e limites

GET/account

Plano, cadência de monitorização, janela de subscrição, quanto de cada quota está a ser usado (prompts, projetos, concorrentes por projeto, tarefas mensais do GEO Writer, membros da equipa) e os limites de taxa da API que se aplicam à sua chave. Chame-o antes de qualquer operação que consuma quota, para poder informar o que resta em vez de descobrir o teto ao atingi-lo. Os limites são resolvidos através do proprietário da conta, por isso um membro da equipa vê a capacidade que se lhe aplica. Uma quota ilimitada devolve limit e remaining como null, com unlimited definido como true.

Parâmetros: nenhum.

CLI e SDKs oficiais

Utilize a CLI nativa num terminal ou adicione um SDK tipado à sua aplicação. Os SDKs são gerados a partir do documento OpenAPI publicado; a CLI é mantida separadamente com base no mesmo contrato da API. Ambos utilizam as chaves de API e o URL base indicados nesta referência.

CLI em Rust

Um cliente Rust nativo para macOS, Linux e Windows, com perfis nomeados e saída em JSON, tabela e CSV. Utilize-o para verificações rápidas, scripts de shell, exportações agendadas e tarefas de CI.

npm install -g @llmpulse/cli

Descarregar a CLI Ler o guia da CLI

SDKs para 12 linguagens

Clientes oficiais gerados para TypeScript, Python, Go, Java, Kotlin, C#, PHP, Ruby, Rust, Swift, Dart e R. Cada cliente mantém-se alinhado com o documento OpenAPI publicado.

Explorar repositórios de SDK Consultar o guia do SDK

Playground da API

Teste endpoints da API em tempo real

Chave de API

Endpoint

Parâmetros

Pré-visualização do pedido

curl -X GET "https://api.llmpulse.ai/api/v1/ping" -H "Authorization: Bearer YOUR_API_KEY"

Resposta

\--

A resposta aparece aqui...

Registe-se para obter a sua chave de API e começar a testar

Obter chave de API

Exemplos de código

Download: OpenAPI Swagger Postman

Perguntar à IA: Abrir no ChatGPT Abrir no Claude Ver como Markdown

Linguagem

Quick Start Example

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30"

const response = await fetch("https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Authorization Header

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/ping"

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/ping", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/ping', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/ping"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Explorar a referência da API

Todos os endpoints, agrupados pelo recurso a que pertencem.

Conceitos essenciais

As regras comuns a todos os endpoints: filtros, definições de métricas, saída em JSON e CSV, colocação em cache, códigos de erro e gestão de versões.

Projetos

Um projeto é uma marca monitorizada: o seu domínio, o idioma, os Prompts e os concorrentes.

Métricas

Dados agregados de visibilidade, Share of Voice, citações e posições da sua marca e dos seus concorrentes, prontos a representar em gráficos.

Concorrentes

As marcas que monitoriza a par da sua. Os IDs de concorrente devolvidos aqui são os valores actor_id que os endpoints de métricas reportam.

Prompts

As perguntas enviadas aos modelos de IA segundo a cadência de monitorização configurada na conta, com os registos correspondentes a cada execução.

Coleções e etiquetas

As coleções (designadas Etiquetas na aplicação) agrupam Prompts por tema, fase do funil ou campanha, para que cada métrica possa ser filtrada por elas.

Respostas (respostas de IA)

As respostas de IA por trás de cada métrica, com o texto completo, menções, citações e análise de sentimento.

Menções e citações

Os registos em bruto por trás das métricas de visibilidade: uma linha por menção de marca ou por URL citado.

Sentimentos

Registos de sentimento com os respetivos comentários, temas e pontuações, bem como o catálogo de categorias usado para os etiquetar.

Fontes e inteligência de citações

Todos os URLs citados pelos modelos, além de vistas agrupadas por URL, domínio e host, metadados da cache de página, evidência de menções dentro das páginas...

AI Model Insights

Partes agregadas do relatório AI Model Insights da aplicação.

Tráfego de IA e de agentes

O que a IA envia realmente para o seu site: o tráfego de referência abrange as pessoas que chegam a partir de assistentes de IA e o tráfego de agentes...

Compras e anúncios

Superfícies comerciais dentro das respostas de IA: os cartões de produto que os modelos devolvem, as colocações pagas que aparecem ao lado e os negócios...

Meios próprios e comunidades

Que canais próprios e que conversas de comunidade as respostas de IA citam.

Reputação e estudos

Relatórios de análise multimodelo: a pontuação mensal da reputação da sua marca face à dos concorrentes e os estudos de IA personalizados que define sobre...

Search Console

Dados de desempenho do Google Search Console (impressões, cliques, CTR, posição média) para projetos com uma propriedade do GSC ligada.

Recomendações

As mesmas execuções de recomendações que alimentam a página Recomendações da aplicação, mais o endpoint que lança uma nova.

GEO Writer

Crie e faça a gestão de tarefas do GEO Writer com IA. As tarefas são processadas de forma assíncrona, por isso crie uma e faça polling até estar concluída.

Relatórios GEO técnicos

Lance o pacote de relatórios GEO técnicos para um URL e, em seguida, liste, faça polling e obtenha cada relatório.

Auditorias GEO

Mantenha uma verificação técnica de GEO sobre um domínio ou URL e acompanhe a sua evolução.

Anotações

Assinale uma data na linha temporal do projeto (o lançamento de uma campanha, uma migração do site, um redesenho) para que um gráfico mostre o que aconteceu...

Equipa

Faça a gestão da equipa da conta: liste os membros e os convites pendentes, convide alguém por email com os projetos e o acesso que terá, revogue um convite...

Integrações com lojas

Os endpoints que suportam a aplicação LLM Pulse para Shopify: associar uma loja ao respetivo projeto, enviar as encomendas que os assistentes de IA...

Webhooks

Receba um HTTP POST assinado sempre que algo acontece num projeto, sem polling.

Integrações

Formas prontas a usar para chamar a API: exemplos de código em sete linguagens, a coleção Postman e o servidor MCP para clientes de IA.

OAuth 2.1

OAuth 2.1 com PKCE e Dynamic Client Registration, para que um cliente MCP se possa ligar ao LLM Pulse sem que o utilizador tenha de colar uma chave de API.

Registo de alterações

Todas as alterações à API REST e às ferramentas MCP, as mais recentes primeiro.