Recommendations

The same recommendation runs that power the in-app Recommendations page, plus the endpoint that launches a new one.

GET`/recommendations`

Lists recommendation runs for a project with type/status filters.

Params:

project_idrequired
recommendation_typeai_visibility|social_community|brand_building|sentiment_reputation
statuspending|processing|completed|failed
page
per_page

Invalid enum values return ERR_INVALID_PARAM.

GET`/recommendations/:id`

One recommendation run with its items and report data: items array with title, priority, action steps, metadata, source references, plus item counts grouped by active, completed, archived.

Params:

project_idrequired
:idin URL
item_statusactive|completed|archived
resolve_source_refsdefault true

POST`/recommendations`

Launch a new generation (same engine as the in-app Recommendations page). Runs async (1-3 minutes); poll GET /recommendations/:id until status is completed. Consumes the project weekly recommendation-item budget (ERR_LIMIT_REACHED when exhausted, or when a run of the same type is already pending). sentiment_reputation requires Scale or above. Requires a writable API key.

Body (JSON):

project_idrequired
recommendation_typeai_visibility default | social_community | brand_building | sentiment_reputation

Code Examples

Download: OpenAPI Swagger Postman

Ask AI: Open in ChatGPT Open in Claude View as Markdown

Language

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());