Empfehlungen

Dieselben Empfehlungsdurchläufe, auf denen die Seite „Empfehlungen“ in der App basiert, dazu der Endpunkt, der einen neuen Durchlauf startet.

GET`/recommendations`

Listet die Empfehlungsdurchläufe eines Projekts auf, filterbar nach Typ und Status.

Parameter:

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

Ungültige Enum-Werte führen zu ERR_INVALID_PARAM.

GET`/recommendations/:id`

Ein Empfehlungsdurchlauf mit seinen Empfehlungspunkten und Berichtsdaten: das Array items mit Titel, Priorität, Handlungsschritten, Metadaten und Quellenverweisen sowie die Anzahl der Punkte, gruppiert nach active, completed und archived.

Parameter:

project_iderforderlich
:idin der URL
item_statusactive|completed|archived
resolve_source_refsStandard true

POST`/recommendations`

Startet eine neue Generierung (dieselbe Logik wie auf der Seite „Empfehlungen“ in der App). Die Generierung läuft asynchron (1 bis 3 Minuten). Fragen Sie GET /recommendations/:id regelmäßig ab, bis der Status completed lautet. Jede Generierung wird auf das wöchentliche Kontingent an Empfehlungspunkten des Projekts angerechnet (ERR_LIMIT_REACHED, wenn es aufgebraucht ist oder bereits ein Durchlauf desselben Typs aussteht). sentiment_reputation ist ab Tarif Scale verfügbar. Erfordert einen API-Schlüssel mit Schreibzugriff.

Anfragetext (JSON):

project_iderforderlich
recommendation_typeai_visibility als Standard | social_community | brand_building | sentiment_reputation

PATCH`/recommendations/:id/items/:item_id`

Markiert einen Empfehlungspunkt eines Durchlaufs als completed, archiviert ihn (archived) oder setzt ihn wieder auf active, wie mit den Schaltflächen auf der Seite „Empfehlungen“. Beim Archivieren können Sie optional einen Grund in reason angeben, aus dem spätere Durchläufe lernen: not_relevant und too_complex sorgen dafür, dass die nächsten Empfehlungen ähnliche Vorschläge meiden, und bei einem Empfehlungspunkt vom Typ „PR & Zitierungsaufbau“, der sich auf eine Domain bezieht, verhindert competitor oder not_relevant, dass diese Website erneut vorgeschlagen wird. Liefert den Empfehlungspunkt in derselben Struktur, in der GET /recommendations/:id die Punkte auflistet. Erfordert einen API-Schlüssel mit Schreibzugriff und bei Teammitgliedern die Berechtigung „Erstellen“ für Empfehlungen. Auch als MCP-Tool update_recommendation_item verfügbar.

Pfad:

:idID des Empfehlungsdurchlaufs
:item_id

Anfragetext (JSON): project_id (erforderlich), status (erforderlich: completed|archived|active), reason (optional, nur mit archived: not_relevant|too_complex|competitor; competitor nur bei Empfehlungspunkten mit metadata.domain). Bei einem Durchlauf oder Empfehlungspunkt außerhalb des Projekts wird ERR_NOT_FOUND zurückgegeben, bei einem Grund, der nicht zutrifft, ERR_INVALID_PARAM.

Codebeispiele

Download: OpenAPI Swagger Postman

KI fragen: In ChatGPT öffnen In Claude öffnen Als Markdown anzeigen

Sprache

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

package main

import "net/http"

func main() {
	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, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	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);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        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

package main

import "net/http"

func main() {
	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, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	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);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        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());
    }
}

Request

curl -X PATCH -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"project_id":"PROJECT_ID","status":"completed"}' \
  "https://api.llmpulse.ai/api/v1/recommendations/123/items/456"

const response = await fetch("https://api.llmpulse.ai/api/v1/recommendations/123/items/456", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"project_id":"PROJECT_ID","status":"completed"})
});
const data = await response.json();

import requests

response = requests.patch(
    "https://api.llmpulse.ai/api/v1/recommendations/123/items/456",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"project_id": "PROJECT_ID", "status": "completed"}
)
data = response.json()

require 'httparty'
require 'json'

response = HTTParty.patch(
  "https://api.llmpulse.ai/api/v1/recommendations/123/items/456",
  headers: {
    "Authorization" => "Bearer YOUR_API_KEY",
    "Content-Type" => "application/json"
  },
  body: { "project_id" => "PROJECT_ID", "status" => "completed" }.to_json
)
data = response.parsed_response

package main

import (
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("PATCH", "https://api.llmpulse.ai/api/v1/recommendations/123/items/456", strings.NewReader(`{"project_id":"PROJECT_ID","status":"completed"}`))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")
	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

$client = new GuzzleHttp\Client();
$response = $client->request('PATCH', 'https://api.llmpulse.ai/api/v1/recommendations/123/items/456', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY'],
    'json' => ['project_id' => 'PROJECT_ID', 'status' => 'completed']
]);
$data = json_decode($response->getBody(), true);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.llmpulse.ai/api/v1/recommendations/123/items/456"))
            .header("Authorization", "Bearer YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"project_id\":\"PROJECT_ID\",\"status\":\"completed\"}"))
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    }
}

Empfehlungen

GET/recommendations

GET/recommendations/:id

POST/recommendations

PATCH/recommendations/:id/items/:item_id

GET`/recommendations`

GET`/recommendations/:id`

POST`/recommendations`

PATCH`/recommendations/:id/items/:item_id`