Três formas de construir sobre seus dados de visibilidade em IA

Sim. A API de visibilidade em busca por IA retorna JSON sobre REST puro, então qualquer coisa que chame um endpoint HTTP consegue lê-la: Looker Studio, Power BI, Tableau, Metabase ou um job de warehouse agendado. Traga pontuações de visibilidade, taxas de menção, posições no ranking e fontes citadas por marca e por mecanismo, e cruze com suas próprias tabelas. Chaves de leitura com escopo (`read:brands`, `read:reports`) garantem que um conector de BI nunca tenha acesso de escrita.

A referência completa está em /docs/v1/, gerada a partir de uma especificação OpenAPI 3.1. Cada endpoint documenta seus parâmetros, o schema de resposta e os códigos de erro, com exemplos executáveis em curl, JavaScript (fetch) e Python (httpx). Como o spec é legível por máquina, você também pode gerar um cliente tipado em qualquer linguagem com openapi-generator, Stainless, Speakeasy ou Fern.

Sim. Uma única requisição retorna dados de visibilidade em IA dos seis mecanismos: ChatGPT, Claude, Gemini, Perplexity, Google AI Mode (AI Overviews) e Grok. Eles são normalizados em um único schema, então você compara posições e citações entre mecanismos sem escrever parsers por plataforma nem manter seis scrapers diferentes.

Sim. Os dados competitivos de visibilidade em busca por IA fazem parte do payload do relatório: junto com a sua marca, os relatórios retornam as marcas concorrentes que cada mecanismo citou para o mesmo prompt, sua posição na resposta e as fontes citadas para elas. Isso permite acompanhar seu share of voice ao longo do tempo e alertar quando um concorrente ultrapassa você em uma categoria.

Quase. Os relatórios rodam sob demanda ou em agenda, e os webhooks de saída enviam `report.completed`, `report.failed`, `schedule.run.completed` e `schedule.run.failed` para seu endpoint no momento em que uma execução termina, com payloads assinados por HMAC. Você não precisa fazer polling: seus sistemas ficam sabendo de novos dados de visibilidade em IA assim que existem.

Sim. A restrição de chave por marca permite gerar uma chave limitada a uma única marca, o que viabiliza painéis empresariais white label por cliente: cada cliente vê só os próprios dados de visibilidade em IA. Combinado com permissões com escopo, escritas idempotentes e um formato de erro estável, a API é feita para sustentar integrações personalizadas em produção.

Gestão de marcas (criar, listar, obter, atualizar, excluir), relatórios de visibilidade em IA nas seis principais plataformas de LLM, rastreamento de citações e fontes com o Rank Prompt Score, relatórios agendados, webhooks de saída, além dos endpoints de conta (`/v1/me`, `/v1/me/quota`). Você também pode conectar um cliente MCP. Auditorias de marca, geração de conteúdo otimizado para IA, auditorias técnicas de SEO e outreach estão no roadmap público e são lançados sob o mesmo contrato /v1; assine o changelog para acompanhar as datas de lançamento. A superfície final espelha o painel 1 para 1.

Todos os planos incluem acesso à API para desenvolvedores, inclusive o gratuito, então você pode gerar uma chave direto da página de Desenvolvedores no seu workspace. Quer uma cota dedicada maior? Assine um plano independente API Starter ou API Pro. Cada chave carrega permissões com escopo (por exemplo, `read:brands`, `write:brands`) e uma restrição de marca opcional para uso white label. As chaves têm o prefixo `rp_live_`, são exibidas uma única vez na criação e ficam com hash no banco.

O acesso à API para desenvolvedores está incluído em todos os planos, com um limite mensal de requisições por nível: 1.000 no Free, 10.000 no Starter, 25.000 no Pro, 50.000 no Agency e 100.000 no Agency Plus. Os endpoints /v1 que consomem créditos (os que usam um LLM pago ou um backend de busca de terceiros) descontam do seu saldo de créditos, então você nunca paga duas vezes; no Free não há créditos mensais, então você recarrega antes de rodar trabalho faturável. Quer uma cota dedicada maior? Duas assinaturas independentes cobrem isso: API Starter ($99/mês, 50.000 unidades de requisição, 500 créditos de API inclusos) e API Pro ($299/mês, 200.000 unidades de requisição, 2.000 créditos de API inclusos). Todo plano aplica um limite de 120 requisições/minuto por chave, e o mapa de custo por endpoint está na documentação para desenvolvedores.

Não. O acesso à API para desenvolvedores está incluído no seu plano, com um limite mensal de requisições que escala por nível (1.000 no Free, depois 10.000 / 25.000 / 50.000 / 100.000). Os endpoints /v1 que consomem créditos usam os mesmos créditos mensais que você já paga, então não há nada extra para comprar. Você só somaria um plano independente API Starter ou API Pro se quiser uma cota de requisições dedicada maior com seus próprios créditos de API inclusos.

Um limite de 120 requisições por minuto móvel é aplicado a toda chave de API, independente do plano. Além disso, seu plano concede uma cota mensal de unidades de requisição. A cota é da conta: toda chave criada nela, a sua e as da sua equipe, usa a mesma cota, e o dono da conta vê e pode revogar qualquer uma. Toda resposta medida inclui `X-RP-Quota-Limit`, `X-RP-Quota-Used`, `X-RP-Quota-Remaining` e `X-RP-Quota-Reset` para você controlar o ritmo sem fazer polling. Chamadas limitadas retornam um 429 com `Retry-After`.

Ainda não. A API é publicada com uma especificação OpenAPI 3.1, então você pode gerar clientes idiomáticos em qualquer linguagem usando openapi-generator, oazapfts, hey-api, Stainless, Speakeasy ou Fern. A documentação inclui exemplos em curl, JavaScript (fetch) e Python (httpx) para cada endpoint. SDKs próprios de TypeScript e Python estão no roadmap.

Os endpoints `GET /v1/me` e `GET /v1/me/quota` custam 0 unidades de requisição e nunca contam contra sua cota, então você pode validar chaves, escopos e assinatura de requisições sem gastar orçamento. Para testes end-to-end completos, gere uma chave separada com escopos limitados e use contra uma marca de teste.

O contrato /v1 é aditivo. Só adicionamos campos e endpoints; nunca removemos ou renomeamos silenciosamente. Quando uma mudança que quebra compatibilidade é inevitável, lançamos /v2 junto com /v1 com uma janela longa de descontinuação, e anunciamos a desativação de qualquer endpoint via o header HTTP padrão `Sunset` com bastante antecedência.

Sim. Opcionalmente, vincule uma chave a uma única marca na criação (`allowed_brand_id`). A API vai recusar qualquer requisição cuja marca alvo não corresponda, mesmo que a chave que chama tenha `write:all`. Isso permite que agências e plataformas emitam chaves por marca para clientes sem criar um novo workspace do Rank Prompt.

Sim, os webhooks estão disponíveis. Cadastre um endpoint por marca com `POST /v1/brands/{brand_id}/webhooks` e assine `report.completed`, `report.failed`, `schedule.run.completed` e `schedule.run.failed`. Os payloads são assinados com HMAC, o segredo de assinatura roda (o segredo antigo continua válido por 24 horas), e um endpoint se desativa automaticamente após falhas repetidas. Você não precisa mais fazer polling do status do relatório a partir de um worker.

Sim. O servidor MCP do Rank Prompt permite que Claude Code, Cursor, Claude Desktop ou qualquer cliente MCP leia seus relatórios, marcas e citações, e rode relatórios em seu nome. Você se conecta via OAuth no navegador, então não há chave nenhuma para colar. Veja a página do servidor MCP em rankprompt.com/mcp para a configuração de 30 segundos.

Autenticação por bearer token sobre TLS, com escopo por recurso. Chamadas CORS do navegador são bloqueadas na borda: a API é somente servidor a servidor. As chaves são guardadas com hash e enviamos o prefixo `rp_live_` para o scanning de segredos do GitHub, então chaves vazadas são detectadas automaticamente. A API roda na mesma infraestrutura reforçada do resto da plataforma Rank Prompt, com opções de residência de dados na UE/EUA.