API-referentie

Aan de slag met de RedReplier API

Met de RedReplier API kunnen externe tools, automatiseringen en AI-agents het monitoren van vermeldingen op Reddit, Hacker News, X, Bluesky en Facebook beheren. Je gebruikt hem om gemonitorde websites aan te maken, trefwoorden te beheren, door AI gescoorde vermeldingen te beoordelen, wijzigingen in de trefwoordfacturering vooraf te bekijken en e-mailmeldingen in te stellen. De API brengt nooit iets in rekening en wijzigt nooit het abonnement: abonnementswijzigingen doe je in de RedReplier-app.

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

Stuur bij elk verzoek een RedReplier API-token mee als Bearer-token. Tokens beginnen met redreplier_; RedReplier haalt het account uit het token.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Het account wordt afgeleid uit het API-token. Stuur geen account- of organisatie-ID's mee. Elke aanroep draait in één workspace: zonder de optionele header X-Workspace-Id komt hij in de standaardworkspace terecht. Een OAuth-login, zoals de connector voor Claude of ChatGPT, kan bij elke workspace waar het lid toe behoort, ook over organisaties heen. Roep Workspaces weergeven aan om ze op te sommen en stuur het gewenste id mee in X-Workspace-Id. Een API-sleutel hoort bij één workspace, dus stuur het eigen id mee of laat de header weg.

X-Workspace-Id: acct_7dK9pQ2

Begin met Websites weergeven om de ID's van websites en trefwoorden te vinden.

Belangrijkste resources:

  • Website: het product, domein of merk dat wordt gemonitord.
  • Trefwoord: een zin die voor een website wordt gezocht op Reddit, Hacker News, X, Bluesky en Facebook.
  • Vermelding: een gevonden post of reactie van Reddit, Hacker News, X, Bluesky of Facebook met een relevanceScore van 0 tot 100.
  • Meldingsinstellingen: frequentie van de e-mailsamenvatting met nieuwe relevante vermeldingen.

Statussen van trefwoorden: PENDING, ACTIVE, DISABLED, SUSPENDED. Statussen van vermeldingen: NEW, APPROVED, REJECTED.

REST-endpoints

Fouten

  • 400 Bad Request: Ongeldige invoer, URL, UUID, enum, queryparameter of body.
  • 401 Unauthorized: Bearer-token ontbreekt of is ongeldig, of code: "token_issuer_lost_access" als de persoon die de API-sleutel heeft aangemaakt is gedeactiveerd of de workspace heeft verlaten.
  • 403 Forbidden: De header X-Workspace-Id noemt een workspace waar deze inloggegevens geen toegang toe hebben, ook als je met een API-sleutel het id van een andere workspace meestuurt. De body bevat code: "workspace_access_denied" en het workspaceId. Een 403 met code: "subscription_required" betekent dat het abonnement van de workspace geen API-toegang bevat. Een 403 met code: "permission_denied" betekent dat je rol in de workspace niet de permissie heeft die de aanroep nodig heeft: RedReplier vraagt redreplier.write, die Admin en Editor hebben. Die body noemt de requiredPermission en je role.
  • 404 Not Found: De resource bestaat niet voor het account van het token.
  • 429 Too Many Requests: Rate limit overschreden. Elke respons bevat RateLimit-Policy, RateLimit-Limit, RateLimit-Remaining en RateLimit-Reset, en een 429 voegt Retry-After in seconden toe. Limieten worden per API-sleutel geteld.
  • 500 Internal Server Error: Onverwachte serverfout.

Een geweigerde workspace geeft dit antwoord:

{
  "statusCode": 403,
  "error": "Forbidden",
  "code": "workspace_access_denied",
  "workspaceId": "acct_3Hm8XwR",
  "message": "You have no access to workspace acct_3Hm8XwR. Call GET /workspaces to list the workspaces you can use, and send one of those ids in the X-Workspace-Id header."
}