API-referentieGET

Gebruik van trefwoordwijzigingen

Bekijk het maandelijkse tegoed voor het bewerken van trefwoorden van het account, hoeveel je hebt gebruikt en hoeveel er over is.

GEThttps://ai.redreplier.com/ai-app/api/v1/keywords/change-usage

Bekijk het maandelijkse tegoed voor het bewerken van trefwoorden van het account, hoeveel je hebt gebruikt en hoeveel er over is.

Bearer-token (RedReplier API-token)

Authenticatie

Stuur bij elk verzoek een RedReplier API-token mee als Bearer-token. Tokens beginnen met redreplier_; RedReplier haalt het account uit het token. Stuur X-Workspace-Id mee om in een andere workspace dan de standaard te werken; zie Workspaces weergeven.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parameters

Dit endpoint heeft geen pad- of queryparameters.

Request body

Dit endpoint heeft geen JSON-body nodig.

Respons

Geeft het huidige gebruik van trefwoordbewerkingen terug.

  • limit (number): Maandelijks tegoed voor trefwoordbewerkingen; -1 betekent onbeperkt.
  • used (number): Trefwoordbewerkingen die deze maand zijn gebruikt.
  • remaining (number): Trefwoordbewerkingen die deze maand over zijn; -1 betekent onbeperkt.
  • unlimited (boolean): Of het tegoed onbeperkt is.

Voorbeeldverzoek

curl -s https://ai.redreplier.com/ai-app/api/v1/keywords/change-usage \
  -H 'Authorization: Bearer redreplier_test_1234567890'

Opmerkingen

Trefwoordbewerkingen zijn onbeperkt in elk huidig abonnement, dus dit geeft limit: -1, used: 0, remaining: -1 en unlimited: true terug. Het endpoint blijft bestaan voor clients die bewerkingen budgetteren. Trefwoorden toevoegen, uitschakelen, inschakelen en verwijderen telde nooit mee.

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: code: "subscription_required" als het abonnement van de workspace geen API-toegang bevat, code: "workspace_access_denied" als X-Workspace-Id een workspace noemt waar deze inloggegevens geen toegang toe hebben, of code: "permission_denied" als je rol in de workspace geen redreplier.write heeft (Admin en Editor hebben die wel).
  • 404 Not Found: De resource bestaat niet voor het account van het token.
  • 429 Too Many Requests: Rate limit overschreden. Wacht het aantal seconden uit Retry-After.
  • 500 Internal Server Error: Onverwachte serverfout.
Voorbeeldverzoek (curl)
curl --request GET \
  --url https://ai.redreplier.com/ai-app/api/v1/keywords/change-usage \
  --header 'Authorization: Bearer redreplier_test_1234567890'
200
{
  "limit": -1,
  "used": 0,
  "remaining": -1,
  "unlimited": true
}