API-Referenz

Erste Schritte mit der RedReplier API

Die RedReplier API verbindet externe Tools, Automationen und KI-Agenten mit Ihrem Mention-Monitoring über Reddit, Hacker News, X, Bluesky und Facebook. Sie können Websites erstellen, Keywords verwalten, KI-bewertete Mentions prüfen, Abrechnungsänderungen vorab prüfen und E-Mail-Alerts konfigurieren. Die API berechnet nie etwas und ändert den Tarif nie: Tarifänderungen erfolgen in der RedReplier-App.

Basis-URL: https://ai.redreplier.com/ai-app/api/v1

Senden Sie bei jeder Anfrage ein RedReplier-API-Token als Bearer-Token. Tokens beginnen mit redreplier_; RedReplier ermittelt das Konto aus dem Token.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Das Konto wird aus dem API-Token abgeleitet. Übergeben Sie keine Account- oder Organisations-IDs. Jeder Aufruf läuft in einem Workspace: Ohne den optionalen Header X-Workspace-Id landet er im Standard-Workspace. Eine OAuth-Anmeldung, etwa über den Claude- oder ChatGPT-Connector, kann jeden Workspace erreichen, dem das Mitglied angehört, über Organisationen hinweg. Rufen Sie Workspaces auflisten auf und senden Sie die gewünschte id in X-Workspace-Id. Ein API-Schlüssel gehört zu einem Workspace, senden Sie also seine eigene id oder lassen Sie den Header weg.

X-Workspace-Id: acct_7dK9pQ2

Beginnen Sie mit Websites auflisten, um Website- und Keyword-IDs zu finden.

Zentrale Ressourcen:

  • Website: Produkt, Domain oder Marke, die überwacht wird.
  • Keyword: Phrase, die für eine Website mit Reddit, Hacker News, X, Bluesky und Facebook abgeglichen wird.
  • Mention: Gefundener Post oder Kommentar aus Reddit, Hacker News, X, Bluesky oder Facebook mit relevanceScore von 0 bis 100.
  • Alert settings: E-Mail-Kadenz für neue relevante Mentions.

Keyword-Statuswerte: PENDING, ACTIVE, DISABLED, SUSPENDED. Mention-Statuswerte: NEW, APPROVED, REJECTED.

REST-Endpoints

Fehler

  • 400 Bad Request: Ungültige Eingabe, URL, UUID, Enum, Query-Parameter oder Body.
  • 401 Unauthorized: Fehlendes oder ungültiges Bearer-Token, oder code: "token_issuer_lost_access", wenn die Person, die den API-Schlüssel erstellt hat, deaktiviert wurde oder den Workspace verlassen hat.
  • 403 Forbidden: Der Header X-Workspace-Id nennt einen Workspace, den diese Zugangsdaten nicht erreichen, auch wenn ein API-Schlüssel mit der id eines anderen Workspace gesendet wird. Der Body enthält code: "workspace_access_denied" und die workspaceId. Ein 403 mit code: "subscription_required" bedeutet, dass der Tarif des Workspace keinen API-Zugang enthält. Ein 403 mit code: "permission_denied" bedeutet, dass Ihre Rolle im Workspace die nötige Berechtigung nicht hat: RedReplier braucht redreplier.write, das Admin und Editor haben. Dieser Body nennt die requiredPermission und Ihre role.
  • 404 Not Found: Die Ressource existiert nicht für das Token-Konto.
  • 429 Too Many Requests: Rate-Limit überschritten. Jede Antwort enthält RateLimit-Policy, RateLimit-Limit, RateLimit-Remaining und RateLimit-Reset, ein 429 zusätzlich Retry-After in Sekunden. Limits werden pro API-Schlüssel gezählt.
  • 500 Internal Server Error: Unerwarteter Serverfehler.

Ein abgelehnter Workspace antwortet:

{
  "statusCode": 403,
  "error": "Forbidden",
  "code": "workspace_access_denied",
  "workspaceId": "acct_3Hm8XwR",
  "message": "Sie haben keinen Zugriff auf den Workspace acct_3Hm8XwR. Rufen Sie GET /workspaces auf, um Ihre verfügbaren Workspaces aufzulisten, und senden Sie eine dieser IDs im Header X-Workspace-Id."
}

Zurück zum Einstieg