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.

GET`/recommendations`

Lista as execuções de recomendações de um projeto com filtros de tipo e estado.

Parâmetros:

project_idobrigatório
recommendation_typeai_visibility|social_community|brand_building|sentiment_reputation
statuspending|processing|completed|failed
page
per_page

Valores de enum inválidos devolvem ERR_INVALID_PARAM.

GET`/recommendations/:id`

Uma execução de recomendações com os respetivos itens e dados do relatório: array de itens com título, prioridade, passos de ação, metadados, referências de origem, além da contagem de itens agrupada por active, completed, archived.

Parâmetros:

project_idobrigatório
:idno URL
item_statusactive|completed|archived
resolve_source_refspredefinido true

POST`/recommendations`

Inicia uma nova geração (o mesmo motor da página Recomendações na aplicação). A execução é assíncrona (1 a 3 minutos); consulte GET /recommendations/:id até o estado indicar completed. Consome o orçamento semanal de itens de recomendação do projeto (ERR_LIMIT_REACHED quando se esgota ou quando já existe uma execução do mesmo tipo pendente). sentiment_reputation requer o plano Scale ou superior. Requer uma chave de API com permissão de escrita.

Corpo (JSON):

project_idobrigatório
recommendation_typeai_visibility predefinido | social_community | brand_building | sentiment_reputation

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/recommendations?project_id=PROJECT_ID&status=pending"

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

import requests

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

require 'httparty'

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

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/recommendations?project_id=PROJECT_ID&status=pending", 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/recommendations?project_id=PROJECT_ID&status=pending', [
    '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/recommendations?project_id=PROJECT_ID&status=pending"))
    .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/recommendations/123?project_id=PROJECT_ID"

const response = await fetch("https://api.llmpulse.ai/api/v1/recommendations/123?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/recommendations/123?project_id=PROJECT_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

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

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

Recomendações

GET/recommendations

GET/recommendations/:id

POST/recommendations

GET`/recommendations`

GET`/recommendations/:id`

POST`/recommendations`