Visão geral da REST API

A API REST do LLM Pulse permite aceder aos dados e executar as operações documentadas para cada endpoint. Não disponibiliza todas as vistas nem todos os cálculos da aplicação; consulte a referência da API para confirmar os campos e os requisitos de cada endpoint. Pode utilizar os dados documentados para criar dashboards e integrações. Disponível no plano Scale ou num plano superior.

Com a REST API do LLM Pulse, pode:

• Obter menções, citações, visibilidade, sentimento e dados de concorrentes de forma programática
• Alimentar os seus próprios dashboards e ferramentas de BI com métricas de visibilidade em IA
• Automatizar relatórios semanais em vez de exportar manualmente
• Criar alertas e fluxos de trabalho personalizados a partir dos seus dados

O que faz

• Endpoints de métricas: dados de séries temporais, estatísticas de resumo e cálculos de Share of Voice
• Endpoints de dimensões: listar projetos, concorrentes, prompts, menções e citações
• Endpoint de Prompts: criar até 100 Prompts em massa de forma programática
• Intelligence Tasks: criar, listar e obter tarefas de conteúdo de IA através da API
• Endpoint de respostas: aceder às respostas completas dos modelos de IA

Escolha como pretende trabalhar

• Utilize a CLI nativa em Rust para consultas no terminal, scripts de shell, exportações CSV agendadas e tarefas de CI no macOS, Linux ou Windows
• Adicione um dos SDKs oficiais para TypeScript, Python, Go, Java, Kotlin, C#, PHP, Ruby, Rust, Swift, Dart ou R
• Chame os endpoints REST diretamente com qualquer cliente HTTP quando quiser controlo total sobre os pedidos

Como utilizar

Tudo começa na página API Keys, onde gera o token bearer que a API utiliza para autenticar cada pedido.

1. Abra o menu de perfil a partir do seu nome ou avatar na parte inferior esquerda da barra lateral e escolha API Keys
2. Adicione a chave como token Bearer: Authorization: Bearer llmpulse_your_key_here
3. URL base: https://api.llmpulse.ai/api/v1
4. Comece com GET /api/v1/dimensions/projects para listar os seus projetos
5. Use GET /api/v1/metrics/timeseries?project_id=ID&metrics=mentions,visibility&range=30 para obter dados de métricas

Sugestões e notas

• Disponível nos planos Scale e superiores
• Limite de pedidos: 300 pedidos por minuto
• Todos os endpoints suportam o formato JSON
• Os cabeçalhos ETags e Last-Modified são suportados para caching
• Códigos de erro padrão: ERR_MISSING_AUTH, ERR_INVALID_API_KEY, ERR_PROJECT_NOT_FOUND
• Documentação completa da API disponível em /api-docs
• Acompanhe novos endpoints, alterações de comportamento, descontinuações e correções através do feed RSS do changelog da API
• Prefere um terminal? Descarregue a CLI nativa em Rust para macOS, Linux ou Windows
• Prefere um cliente com tipos? Consulte os SDKs oficiais para TypeScript, Python, Go, Java, Kotlin, C#, PHP, Ruby, Rust, Swift, Dart e R