Projetos

Um projeto é uma marca monitorizada: o seu domínio, o idioma, os Prompts e os concorrentes. Quase todos os outros endpoints recebem um project_id, por isso comece por aqui.

GET`/dimensions/projects`

Lista os projetos do utilizador autenticado (isto é também uma verificação de autenticação).

GET`/dimensions/projects/:id`

Obtenha informações detalhadas sobre um projeto: nomes correspondentes, setor, modelo de negócio, contagens de prompts por foco de marca e data_coverage (os modelos, países e idiomas que têm efetivamente dados), para que uma única chamada substitua as consultas separadas de modelos e idiomas.

GET`/dimensions/models`

Lista os modelos presentes nas métricas diárias do projeto.

GET`/dimensions/locales`

Lista os países e os idiomas presentes nas métricas diárias do projeto.

POST`/projects`

Cria um projeto completo numa única chamada (modo rápido): projeto, prompts (colocados em fila para execução + categorização), concorrentes e subscrição de email semanal. Idempotente quando é fornecido external_identifier. O projeto pertence sempre ao proprietário da conta.

Corpo (JSON): website_url (URL HTTP(S) pública obrigatória, com um nome de anfitrião DNS ou um endereço IP público; são rejeitadas credenciais, endereços IP privados e especiais, localhost e nomes de anfitrião internos), name (obrigatório), main_country (obrigatório), main_language (obrigatório), brand_name, description, industry (uma chave ou um array; uma chave desconhecida é rejeitada e as chaves válidas são indicadas), business_model, target_audience, brand_voice, goals, primary_products (array), matching_names (array), prompts (array, máximo 100), collections (array de {name, prompts}, máximo 50, cada uma associa prompts do mesmo pedido através do respetivo texto exato), competitors (array de {domain, brand_name, matching_names}), owned_media (objeto, plano Growth ou superior), use_subdomain, weekly_email_subscribed, external_identifier (apenas em contas com embed ativado; chave de idempotência, [a-z0-9_-]{1,64}), execute_prompts_immediately (predefinição true).

PATCH`/projects/:id`

Atualiza o perfil do projeto (o Brand Book e a correspondência de marca), com os mesmos campos das Definições do projeto. Os sete campos do Brand Book (industry, business_model, description, primary_products, target_audience, brand_voice, goals) alimentam todas as tarefas do GEO Writer e as sugestões de prompts. industry, description e target_audience também ajudam as Recomendações a calibrar os seus conselhos. Alterar matching_names reexecuta a correspondência de menções e citações sobre o histórico do projeto em segundo plano (rematching: true; as edições ficam bloqueadas entretanto); uma alteração a brand_name só se aplica a execuções futuras. Campos desconhecidos são rejeitados.

Corpo (JSON), envie apenas os campos a alterar: name (nome apresentado; não altera a deteção de menções, salvo se brand_name estiver vazio), brand_name, description, industry (uma chave ou um array, que é armazenado como array), business_model, target_audience, brand_voice, goals, primary_products (array de substituição integral), matching_names (array de substituição integral; envie todas as variantes que pretende manter).

Assistente de rascunhos de projeto

Assistente de projeto em vários passos com sugestões de IA: POST /project_drafts inicia um rascunho (devolve sugestões de nome, descrição e setor para o URL), o PATCH submete cada passo (details, prompts, competitors, owned_media) com um controlo rigoroso da ordem e devolve sugestões para o passo seguinte, e POST /project_drafts/:id/finalize cria o projeto real. Os rascunhos expiram após 24h.

O website_url inicial tem de ser um URL HTTP(S) público com um nome de anfitrião DNS ou um endereço IP público. São rejeitadas credenciais, endereços IP privados e especiais, localhost e nomes de anfitrião internos. Passos: details (nome obrigatório), prompts (máximo 100, validado face à quota), competitors (limitado pelo plano), owned_media (opcional, Growth+). Sugestões por passo, com exclusão através de suggest=false; os URLs novos podem demorar até cerca de 2 minutos, pelo que deve definir o timeout do cliente em 180s. A finalização é idempotente e revalida todos os controlos.

Exemplos de código

Download: OpenAPI Swagger Postman

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

Linguagem

Request

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

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/dimensions/projects",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/dimensions/projects", 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/dimensions/projects', [
    '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/dimensions/projects"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{ "projects":[ { "id":4, "name":"Acme" } ], "request_id":"..." }

Request

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

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/dimensions/projects/PROJECT_ID",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/dimensions/projects/PROJECT_ID", 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/dimensions/projects/PROJECT_ID', [
    '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/dimensions/projects/PROJECT_ID"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{
  "id": 107, "name": "Acme Corp", "url": "https://acme.com",
  "matching_names": ["Acme", "Acme Corp", "acme.com"],
  "industry": "SaaS", "business_model": "B2B",
  "stats": { "prompts_count": 50, "prompts_by_brand_kind": { "brand": 12, "brand_other": 8, "non_brand": 30 },
             "competitors_count": 5, "collections_count": 3 },
  "data_coverage": { "models": ["chatgpt", "perplexity", "gemini"], "countries": ["US"], "languages": ["en"] },
  "request_id": "..."
}

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/dimensions/models?project_id=PROJECT_ID"

const response = await fetch("https://api.llmpulse.ai/api/v1/dimensions/models?project_id=PROJECT_ID", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/dimensions/models?project_id=PROJECT_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/dimensions/models?project_id=PROJECT_ID",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/dimensions/models?project_id=PROJECT_ID", 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/dimensions/models?project_id=PROJECT_ID', [
    '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/dimensions/models?project_id=PROJECT_ID"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/dimensions/locales?project_id=PROJECT_ID"

const response = await fetch("https://api.llmpulse.ai/api/v1/dimensions/locales?project_id=PROJECT_ID", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/dimensions/locales?project_id=PROJECT_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/dimensions/locales?project_id=PROJECT_ID",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/dimensions/locales?project_id=PROJECT_ID", 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/dimensions/locales?project_id=PROJECT_ID', [
    '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/dimensions/locales?project_id=PROJECT_ID"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{ "project_id":1, "countries":["ES","FR"], "languages":["es","en"], "request_id":"..." }

Request

curl -X PATCH -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"description":"CRM software for SMBs","industry":"SAAS","brand_voice":"Direct, practical, no fluff","target_audience":"Sales teams at SMBs"}' \
  "https://api.llmpulse.ai/api/v1/projects/PROJECT_ID"

const response = await fetch("https://api.llmpulse.ai/api/v1/projects/PROJECT_ID", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"description":"CRM software for SMBs","industry":"SAAS","brand_voice":"Direct, practical, no fluff","target_audience":"Sales teams at SMBs"})
});
const data = await response.json();

import requests

response = requests.patch(
    "https://api.llmpulse.ai/api/v1/projects/PROJECT_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"description":"CRM software for SMBs","industry":"SAAS","brand_voice":"Direct, practical, no fluff","target_audience":"Sales teams at SMBs"}
)
data = response.json()

require 'httparty'

response = HTTParty.patch(
  "https://api.llmpulse.ai/api/v1/projects/PROJECT_ID",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" },
  body: {"description":"CRM software for SMBs","industry":"SAAS","brand_voice":"Direct, practical, no fluff","target_audience":"Sales teams at SMBs"}
)
data = response.parsed_response

req, _ := http.NewRequest("PATCH", "https://api.llmpulse.ai/api/v1/projects/PROJECT_ID", strings.NewReader(`{"description":"CRM software for SMBs","industry":"SAAS","brand_voice":"Direct, practical, no fluff","target_audience":"Sales teams at SMBs"}`))
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('PATCH', 'https://api.llmpulse.ai/api/v1/projects/PROJECT_ID', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY'],
    'json' => {"description":"CRM software for SMBs","industry":"SAAS","brand_voice":"Direct, practical, no fluff","target_audience":"Sales teams at SMBs"}
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/projects/PROJECT_ID"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .PATCH(HttpRequest.BodyPublishers.ofString("{\"description\":\"CRM software for SMBs\",\"industry\":\"SAAS\",\"brand_voice\":\"Direct, practical, no fluff\",\"target_audience\":\"Sales teams at SMBs\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Projetos

GET/dimensions/projects

GET/dimensions/projects/:id

GET/dimensions/models

GET/dimensions/locales

POST/projects

PATCH/projects/:id

Assistente de rascunhos de projeto

GET`/dimensions/projects`

GET`/dimensions/projects/:id`

GET`/dimensions/models`

GET`/dimensions/locales`

POST`/projects`

PATCH`/projects/:id`